Linux Cubed Series 2: Applications

home *** CD-ROM | disk | FTP | other *** search

/ Linux Cubed Series 2: Applications / Linux Cubed Series 2 - Applications.iso / editors / emacs / xemacs / xemacs-1.003 / xemacs-1 / lib / xemacs-19.13 / i486-unknown-linuxaout1.3.21 / DOC-19.13-XEmacs < prev next >

Wrap

Text File | 1995-09-01 | 895.6 KB | 20,757 lines

Fvalid-device-class-p Given a DEVICE-CLASS, return t if it is valid. Valid classes are 'color, 'grayscale, and 'mono. arguments: (DEVICE-CLASS) Fvalid-device-type-p Given a DEVICE-TYPE, return t if it is valid. Valid types are 'x, 'tty, and 'stream. arguments: (DEVICE-TYPE) Fdevice-class-list Return a list of valid device classes. arguments: () Fdevice-type-list Return a list of valid device types. arguments: () Fdfw-device Given a device, frame, or window, return the associated device. Return nil otherwise. arguments: (OBJ) Fselected-device Return the device which is currently active. arguments: () Fselect-device Select the device DEVICE. Subsequent editing commands apply to its selected frame and selected window. The selection of DEVICE lasts until the next time the user does something to select a different device, or until the next time this function is called. arguments: (DEVICE) Fdevicep Return non-nil if OBJECT is a device. arguments: (OBJECT) Fdevice-live-p Return non-nil if OBJECT is a device that has not been deleted. arguments: (OBJECT) Fdevice-type Return the type of the specified device (e.g. `x' or `tty'). Value is `tty' for a tty device (a character-only terminal), `x' for a device which is a connection to an X server, `stream' for a stream device (which acts like a stdio stream), and `dead' for a deleted device. arguments: (&optional DEVICE) Fdevice-name Return the name of the specified device. arguments: (&optional DEVICE) Fmake-device Create a new device of type TYPE. PARAMS, if specified, should be an alist of parameters controlling device creation. arguments: (TYPE &optional PARAMS) Fdelete-device Delete DEVICE, permanently eliminating it from use. arguments: (DEVICE) Fdevice-list Return a list of all devices. arguments: () Fdevice-frame-list Return a list of all frames on DEVICE. If DEVICE is nil, the selected device will be used. arguments: (&optional DEVICE) Fdevice-class Return the class (color behavior) of DEVICE. This will be one of 'color, 'grayscale, or 'mono. arguments: (&optional DEVICE) Fdevice-pixel-width Return the width in pixels of DEVICE, or nil if unknown. arguments: (&optional DEVICE) Fdevice-pixel-height Return the height in pixels of DEVICE, or nil if unknown. arguments: (&optional DEVICE) Fdevice-mm-width Return the width in millimeters of DEVICE, or nil if unknown. arguments: (&optional DEVICE) Fdevice-mm-height Return the height in millimeters of DEVICE, or nil if unknown. arguments: (&optional DEVICE) Fdevice-bitplanes Return the number of bitplanes of DEVICE, or nil if unknown. arguments: (&optional DEVICE) Fdevice-color-cells Return the number of color cells of DEVICE, or nil if unknown. arguments: (&optional DEVICE) Fset-device-baud-rate Set the output baud rate of DEVICE to RATE. On most systems, changing this value will affect the amount of padding and other strategic decisions made during redisplay. arguments: (DEVICE RATE) Fdevice-baud-rate Return the output baud rate of DEVICE. arguments: (&optional DEVICE) Fdevice-enable-input Enable input on device DEVICE. arguments: (DEVICE) Fdevice-disable-input Disable input on device DEVICE. arguments: (DEVICE) Fdevice-function-key-map Return the function key mapping for DEVICE. arguments: (&optional DEVICE) Fset-device-function-key-map Set the function key mapping for DEVICE to KEYMAP. arguments: (DEVICE KEYMAP) Vcreate-device-hook Function or functions to call when a device is created. One argument, the newly-created device. Note that the device will not be selected and will not have any frames on it.Vdelete-device-hook Function or functions to call when a device is deleted. One argument, the to-be-deleted device.Fx-debug-mode With a true arg, make the connection to the X server synchronous. With false, make it asynchronous. Synchronous connections are much slower, but are useful for debugging. (If you get X errors, make the connection synchronous, and use a debugger to set a breakpoint on `x_error_handler'. Your backtrace of the C stack will now be useful. In asynchronous mode, the stack above `x_error_handler' isn't helpful because of buffering.) If DEVICE is not specified, the selected device is assumed. Calling this function is the same as calling the C function `XSynchronize', or starting the program with the `-sync' command line argument. arguments: (ARG &optional DEVICE) Fx-get-resource Retrieve an X resource from the resource manager. The first arg is the name of the resource to retrieve, such as "font". The second arg is the class of the resource to retrieve, like "Font". The third arg should be one of the symbols 'string, 'integer, 'natnum, or 'boolean, specifying the type of object that the database is searched for. The fourth arg is the locale to search for the resources on, and can currently be a a buffer, a frame, a device, or 'global. If omitted, it defaults to 'global. The fifth arg is the device to search for the resources on. (The resource database for a particular device is constructed by combining non-device- specific resources such any command-line resources specified and any app-defaults files found [or the fallback resources supplied by XEmacs, if no app-defaults file is found] with device-specific resources such as those supplied using xrdb.) If omitted, it defaults to the device of LOCALE, if a device can be derived (i.e. if LOCALE is a frame or device), and otherwise defaults to the value of `default-x-device'. The sixth arg NOERROR, if non-nil, means do not signal an error if a bogus resource specification was retrieved (e.g. if a non-integer was given when an integer was requested). In this case, a warning is issued instead. The resource names passed to this function are looked up relative to the locale. If you want to search for a subresource, you just need to specify the resource levels in NAME and CLASS. For example, NAME could be "modeline.attributeFont", and CLASS "Face.AttributeFont". Specifically, 1) If LOCALE is a buffer, a call (x-get-resource "foreground" "Foreground" 'string SOME-BUFFER) is an interface to a C call something like XrmGetResource (db, "xemacs.buffer.BUFFER-NAME.foreground", "Emacs.EmacsLocaleType.EmacsBuffer.Foreground", "String"); 2) If LOCALE is a frame, a call (x-get-resource "foreground" "Foreground" 'string SOME-FRAME) is an interface to a C call something like XrmGetResource (db, "xemacs.frame.FRAME-NAME.foreground", "Emacs.EmacsLocaleType.EmacsFrame.Foreground", "String"); 3) If LOCALE is a device, a call (x-get-resource "foreground" "Foreground" 'string SOME-DEVICE) is an interface to a C call something like XrmGetResource (db, "xemacs.device.DEVICE-NAME.foreground", "Emacs.EmacsLocaleType.EmacsDevice.Foreground", "String"); 4) If LOCALE is 'global, a call (x-get-resource "foreground" "Foreground" 'string 'global) is an interface to a C call something like XrmGetResource (db, "xemacs.foreground", "Emacs.Foreground", "String"); Note that for 'global, no prefix is added other than that of the application itself; thus, you can use this locale to retrieve arbitrary application resources, if you really want to. The returned value of this function is nil if the queried resource is not found. If the third arg is `string', a string is returned, and if it is `integer', an integer is returned. If the third arg is `boolean', then the returned value is the list (t) for true, (nil) for false, and is nil to mean ``unspecified.'' arguments: (NAME CLASS TYPE &optional LOCALE DEVICE NO-ERROR) Fx-get-resource-prefix Return the resource prefix for LOCALE on DEVICE. The resource prefix is the strings used to prefix resources if the LOCALE and DEVICE arguments were passed to `x-get-resource'. The returned value is a cons of a name prefix and a class prefix. For example, if LOCALE is a frame, the returned value might be ("xemacs.frame.FRAME-NAME" . "Emacs.EmacsLocaleType.EmacsFrame"). If no valid X device for resourcing can be obtained, this function returns nil. (In such a case, `x-get-resource' would always return nil.) arguments: (LOCALE &optional DEVICE) Fx-put-resource Add a resource to the resource database for DEVICE. RESOURCE-LINE specifies the resource to add and should be a standard resource specification. arguments: (RESOURCE-LINE &optional DEVICE) Fdefault-x-device Return the default X device for resourcing. This is the first-created X device that still exists. arguments: () Fdevice-x-display Return the X display which DEVICE is connected to, as a string. arguments: (&optional DEVICE) Fdevice-x-argv-list You should probably not be using this function. arguments: (&optional DEVICE) Fx-display-visual-class Return the visual class of the X display `device' is on. The returned value will be one of the symbols `static-gray', `gray-scale', `static-color', `pseudo-color', `true-color', or `direct-color'. arguments: (&optional DEVICE) Fx-server-vendor Return the vendor ID string of the X server `device' on. arguments: (&optional DEVICE) Fx-server-version Return the version numbers of the X server `device' is on. The returned value is a list of three integers: the major and minor version numbers of the X Protocol in use, and the vendor-specific release number. See also `x-server-vendor'. arguments: (&optional DEVICE) Fx-valid-keysym-name-p Return true if KEYSYM names a keysym that the X library knows about. Valid keysyms are listed in the files /usr/include/X11/keysymdef.h and in /usr/lib/X11/XKeysymDB, or whatever the equivalents are on your system. arguments: (KEYSYM) Fx-grab-pointer Grab the pointer and restrict it to its current window. If optional DEVICE argument is nil, the default device will be used. If optional CURSOR argument is non-nil, change the pointer shape to that until `x-ungrab-pointer' is called (it should be an object returned by the `make-cursor' function). If the second optional argument IGNORE-KEYBOARD is non-nil, ignore all keyboard events during the grab. Returns t if the grab is successful, nil otherwise. arguments: (&optional DEVICE CURSOR IGNORE-KEYBOARD) Fx-ungrab-pointer Release a pointer grab made with `x-grab-pointer'. If optional first arg DEVICE is nil the default device is used. If it is t the pointer will be released on all X devices. arguments: (&optional DEVICE) Fx-grab-keyboard Grab the keyboard on the given device (defaulting to the selected one). So long as the keyboard is grabbed, all keyboard events will be delivered to emacs -- it is not possible for other X clients to eavesdrop on them. Ungrab the keyboard with `x-ungrab-keyboard' (use an unwind-protect). Returns t if the grab was successful; nil otherwise. arguments: (&optional DEVICE) Fx-ungrab-keyboard Release a keyboard grab made with `x-grab-keyboard'. arguments: (&optional DEVICE) Vx-emacs-application-class The X application class of the XEmacs process. This controls, among other things, the name of the `app-defaults' file that XEmacs will use. For changes to this variable to take effect, they must be made before the connection to the X server is initialized, that is, this variable may only be changed before emacs is dumped, or by setting it in the file lisp/term/x-win.el.Fdevice-tty-tty Return the tty filename which DEVICE is connected to, as a string. arguments: (&optional DEVICE) Fdevice-tty-terminal-type Return the terminal type of TTY device DEVICE. arguments: (&optional DEVICE) Vdefault-tty-frame-alist Alist of default frame-creation parameters for tty frames. These are in addition to and override what is specified in `default-frame-alist', but are overridden by the arguments to the particular call to `make-frame'.Fmake-frame Create a new frame, displaying the current buffer. Optional argument PARAMETERS is an alist of parameters for the new frame. Specifically, PARAMETERS is a list of pairs, each having one of the following forms: (name . STRING) - The frame should be named STRING. (height . NUMBER) - The frame should be NUMBER text lines high. (width . NUMBER) - The frame should be NUMBER columns wide. The documentation for the variable `default-x-frame-alist' describes additional frame parameters that Emacs recognizes for X window frames. arguments: (&optional PARAMETERS DEVICE) Fframep Return non-nil if OBJECT is a frame. arguments: (OBJECT) Fframe-type Return the type of the specified frame (e.g. `x' or `tty'). This is equivalent to the type of the frame's device. Value is `tty' for a tty frame (a character-only terminal), `x' for a frame that is an X window, `stream' for a stream frame (which acts like a stdio stream), and `dead' for a deleted frame. arguments: (FRAME) Fframe-live-p Return non-nil if OBJECT is a frame which has not been deleted. arguments: (OBJECT) Fselect-frame Select the frame FRAME. Subsequent editing commands apply to its selected window. The selection of FRAME lasts until the next time the user does something to select a different frame, or until the next time this function is called. Note that this does not actually cause the window-system focus to be set to this frame, or the select-frame-hook or deselect-frame-hook to be run, until the next time that XEmacs is waiting for an event. arguments: (FRAME) Fselected-frame Return the frame that is now selected on device DEVICE. If DEVICE is not specified, the selected device will be used. If no frames exist on the device, nil is returned. arguments: (&optional DEVICE) Fframe-root-window Return the root-window of FRAME. If omitted, FRAME defaults to the currently selected frame. arguments: (&optional FRAME) Fframe-selected-window Return the selected window of frame object FRAME. If omitted, FRAME defaults to the currently selected frame. arguments: (&optional FRAME) Fset-frame-selected-window Set the selected window of frame object FRAME to WINDOW. If FRAME is nil, the selected frame is used. If FRAME is the selected frame, this makes WINDOW the selected window. arguments: (FRAME WINDOW) Fframe-lowest-window Return the lowest window on FRAME which is at POSITION. If omitted, FRAME defaults to the currently selected frame. If omitted, POSITION defaults to 0 which is the leftmost lowest window. If POSITION is negative, it is considered to start from the right. The rightmost lowest window has a position of -1. If there is no window at the given POSITION, return nil. arguments: (&optional FRAME POSITION) Fframe-highest-window Return the highest window on FRAME which is at POSITION. If omitted, FRAME defaults to the currently selected frame. If omitted, POSITION defaults to 0 which is the leftmost highest window. If POSITION is negative, it is considered to start from the right. The rightmost highest window has a position of -1. If there is no window at the given POSITION, return nil. arguments: (&optional FRAME POSITION) Fframe-device Return the device that FRAME is on. If omitted, FRAME defaults to the currently selected frame. arguments: (&optional FRAME) Fnext-frame Return the next frame in the frame list after FRAME. By default, skip minibuffer-only frames. If omitted, FRAME defaults to the selected frame. If optional argument MINIBUF is nil, exclude minibuffer-only frames. If MINIBUF is a window, include only its own frame and any frame now using that window as the minibuffer. If MINIBUF is `visible', include all visible frames. If MINIBUF is 0, include all visible and iconified frames. Otherwise, include all frames. arguments: (&optional FRAME MINIBUF) Fprevious-frame Return the previous frame in the frame list before FRAME. By default, skip minibuffer-only frames. If omitted, FRAME defaults to the selected frame. If optional argument MINIBUF is nil, exclude minibuffer-only frames. If MINIBUF is a window, include only its own frame and any frame now using that window as the minibuffer. If MINIBUF is `visible', include all visible frames. If MINIBUF is 0, include all visible and iconified frames. Otherwise, include all frames. arguments: (&optional FRAME MINIBUF) Fdelete-frame Delete FRAME, permanently eliminating it from use. If omitted, FRAME defaults to the selected frame. A frame may not be deleted if its minibuffer is used by other frames. arguments: (&optional FRAME IGNORED) Fmouse-position Return a list (WINDOW X . Y) giving the current mouse window and position. The position is given in character cells, where (0, 0) is the upper-left corner of the window. DEVICE specifies the device on which to read the mouse position, and defaults to the selected device. If the device is a mouseless terminal or Emacs hasn't been programmed to read its mouse position, it returns the device's selected window for WINDOW and nil for X and Y. arguments: (&optional DEVICE) Fmouse-pixel-position Return a list (WINDOW X . Y) giving the current mouse window and position. The position is given in pixel units, where (0, 0) is the upper-left corner. DEVICE specifies the device on which to read the mouse position, and defaults to the selected device. If the device is a mouseless terminal or Emacs hasn't been programmed to read its mouse position, it returns the device's selected window for FRAME and nil for X and Y. arguments: (&optional DEVICE) Fset-mouse-position Move the mouse pointer to the center of character cell (X,Y) in WINDOW. arguments: (WINDOW X Y) Fset-mouse-pixel-position Move the mouse pointer to pixel position (X,Y) in WINDOW. arguments: (WINDOW X Y) Fframe-configuration Return object describing current frame configuration. The frame configuration is the current mouse position and selected frame. This object can be given to `restore-frame-configuration' to restore this frame configuration. arguments: () Frestore-frame-configuration Restores frame configuration CONFIGURATION. arguments: (CONFIG) Fmake-frame-visible Make the frame FRAME visible (assuming it is an X-window). If omitted, FRAME defaults to the currently selected frame. Also raises the frame so that nothing obscures it. arguments: (&optional FRAME) Fmake-frame-invisible Unconditionally removes frame from the display (assuming it is an X-window). If omitted, FRAME defaults to the currently selected frame. If what you want to do is iconify the frame (if the window manager uses icons) then you should call `iconify-frame' instead. arguments: (&optional FRAME IGNORED) Ficonify-frame Make the frame FRAME into an icon, if the window manager supports icons. If omitted, FRAME defaults to the currently selected frame. arguments: (&optional FRAME) Fdeiconify-frame Open (de-iconify) the iconified frame FRAME. Under X, this is currently the same as `make-frame-visible'. If omitted, FRAME defaults to the currently selected frame. Also raises the frame so that nothing obscures it. arguments: (&optional FRAME) Fframe-visible-p Return t if FRAME is now "visible" (actually in use for display). A frame that is not visible is not updated, and, if it works through a window system, may not show at all. arguments: (FRAME) Fframe-totally-visible-p Return T if frame is not obscured by any other X windows, NIL otherwise. Always returns t for tty frames. arguments: (&optional FRAME) Fframe-iconified-p Return t if FRAME is iconified. Not all window managers use icons; some merely unmap the window, so this function is not the inverse of `frame-visible-p'. It is possible for a frame to not be visible and not be iconified either. However, if the frame is iconified, it will not be visible. arguments: (FRAME) Fvisible-frame-list Return a list of all frames now "visible" (being updated). If DEVICE is specified only frames on that device will be returned. arguments: (&optional DEVICE) Fraise-frame Bring FRAME to the front, so it occludes any frames it overlaps. If omitted, FRAME defaults to the currently selected frame. If FRAME is invisible, make it visible. If Emacs is displaying on an ordinary terminal or some other device which doesn't support multiple overlapping frames, this function does nothing. arguments: (&optional FRAME) Flower-frame Send FRAME to the back, so it is occluded by any frames that overlap it. If omitted, FRAME defaults to the currently selected frame. If Emacs is displaying on an ordinary terminal or some other device which doesn't support multiple overlapping frames, this function does nothing. arguments: (&optional FRAME) Fframe-parameters Return the parameters-alist of frame FRAME. It is a list of elements of the form (PARM . VALUE), where PARM is a symbol. The meaningful PARMs depend on the kind of frame. If FRAME is omitted, return information on the currently selected frame. See the variables `default-frame-alist', `default-x-frame-alist', and `default-tty-frame-alist' for a description of the parameters meaningful for particular types of frames. arguments: (&optional FRAME) Fmodify-frame-parameters Modify the parameters of frame FRAME according to ALIST. ALIST is an alist of parameters to change and their new values. Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol. The meaningful PARMs depend on the kind of frame; undefined PARMs are ignored. See the variables `default-frame-alist', `default-x-frame-alist', and `default-tty-frame-alist' for a description of the parameters recognized for particular types of frames. arguments: (FRAME ALIST) Fframe-height Return number of lines available for display on FRAME. arguments: (&optional FRAME) Fframe-width Return number of columns available for display on FRAME. arguments: (&optional FRAME) Fframe-pixel-height Return the height in pixels of FRAME. arguments: (&optional FRAME) Fframe-pixel-width Return the width in pixels of FRAME. arguments: (&optional FRAME) Fframe-name Return the name of FRAME (defaulting to the selected frame). This is not the same as the `title' of the frame. arguments: (&optional FRAME) Fset-frame-height Specify that the frame FRAME has LINES lines. Optional third arg non-nil means that redisplay should use LINES lines but that the idea of the actual height of the frame should not be changed. arguments: (FRAME ROWS &optional PRETEND) Fset-frame-width Specify that the frame FRAME has COLS columns. Optional third arg non-nil means that redisplay should use COLS columns but that the idea of the actual width of the frame should not be changed. arguments: (FRAME COLS &optional PRETEND) Fset-frame-size Sets size of FRAME to COLS by ROWS. Optional fourth arg non-nil means that redisplay should use COLS by ROWS but that the idea of the actual size of the frame should not be changed. arguments: (FRAME COLS ROWS &optional PRETEND) Fset-frame-position Sets position of FRAME in pixels to XOFFSET by YOFFSET. This is actually the position of the upper left corner of the frame. Negative values for XOFFSET or YOFFSET are interpreted relative to the rightmost or bottommost possible position (that stays within the screen). arguments: (FRAME XOFFSET YOFFSET) Vdefault-minibuffer-frame A frame-object holding the default minibuffer for minibufferless frames. When you create a minibufferless frame, by default it will use the minibuffer of this frame. It is up to you to create a suitable frame and store it in this variable.Vdelete-frame-hook Function or functions to call when a frame is deleted. One argument, the to-be-deleted frame.Vcreate-frame-hook Function or functions to call when a frame is created. One argument, the newly-created frame.Vmouse-enter-frame-hook Function or functions to call when mouse enters a frame. One argument, the frame. Be careful not to make assumptions about the window manger's focus model. In most cases, the `deselect-frame-hook' is more appropriate.Vmouse-leave-frame-hook Function or functions to call when mouse leaves frame. One argument, the frame. Be careful not to make assumptions about the window manger's focus model. In most cases, the `select-frame-hook' is more appropriate.Vmap-frame-hook Function or functions to call when frame is mapped. One argument, the frame.Vunmap-frame-hook Function or functions to call when frame is unmapped. One argument, the frame.Vmouse-motion-handler Handler for motion events. One arg, the event. For most applications, you should use `mode-motion-hook' instead of this.Vsynchronize-minibuffers Set to t if all minibuffer windows are to be synchronized. This will cause echo area messages to appear in the minibuffers of all visible frames.Vframe-title-format Controls the title of the X window corresponding to the selected frame. This is the same format as `modeline-format' with the exception that %- is ignored.Vframe-icon-title-format Controls the title of the icon corresponding to the selected frame. See also the variable `frame-title-format'Vdefault-frame-name The default name to assign to newly-created frames. This can be overridden by arguments to `make-frame'. This must be a string.Vdefault-frame-alist Alist of default values for frame creation, other than the first one. These may be set in your init file, like this: (setq default-frame-alist '((width . 80) (height . 55))) Since the first X frame is created before loading your .emacs file, you must use the X resource database for that. See also the variables `default-x-frame-alist' and `default-tty-frame-alist', which are like `default-frame-alist' except that they apply only to X or tty frames, respectively (whereas `default-frame-alist' applies to all types of frames).Fredisplay-echo-area Ensure that all minibuffers are correctly showing the echo area. arguments: () Fredraw-frame Clear frame FRAME and output again what is supposed to appear on it. arguments: (FRAME) Fredraw-display Redraw all frames on DEVICE marked as having their image garbled. DEVICE defaults to the selected device. If DEVICE is t, all devices will have their frames checked. arguments: (&optional DEVICE) Fredraw-modeline Force the modeline of the current buffer to be redisplayed. With optional non-nil ALL, force redisplay of all modelines. arguments: (&optional ALL) Fforce-redisplay Force an immediate redisplay of all frames. Will still cause a redisplay when there is input pending (unlike when the display is updated from `next-event'). This function differs from `redraw-display' in that it causes an immediate, visible update of the display's contents. Unlike `redraw-frame' or `recenter', it does not mark any frame's current contents as invalid. arguments: () Fforce-cursor-redisplay Force an immediate update of the cursor on the selected frame. arguments: () Vredisplay-cache-adjustment (Temporary) Setting this will impact the performance of the internal line start cache.Vglobal-mode-string String displayed by modeline-format's "%m" specification.Vscroll-step *The number of lines to try scrolling a window by when point moves out. If that fails to bring point back on frame, point is centered instead. If this is zero, point is always centered after it moves off frame.Vline-number-mode *Whether to display line numbers in the modeline.Vvisible-bell *Non-nil means try to flash the frame to represent a bell.Vno-redraw-on-reenter *Non-nil means no need to redraw entire frame after suspending. A non-nil value is useful if the terminal can automatically preserve Emacs's frame display when you reenter Emacs. It is up to you to set this variable if your terminal can do that.Vwindow-system A symbol naming the window-system under which Emacs is running, such as `x', or nil if emacs is running on an ordinary terminal. This variable is OBSOLETE and will be removed in a future version.Vinitial-window-system DON'T TOUCHVwindow-system-version The version number of the window system in use. For X windows, this is 10 or 11.Vcursor-in-echo-area Non-nil means put cursor in minibuffer, at end of any message there.Vbar-cursor Use vertical bar cursor if non-nil. If t width is 1 pixel, otherwise 2.Vpre-redisplay-hook Function or functions to run before every redisplay. Functions on this hook must be careful to avoid signalling errors!Vpost-redisplay-hook Function or functions to run after every redisplay. Functions on this hook must be careful to avoid signalling errors!Vdisplay-warning-tick Bump this to tell the C code to call `display-warning-buffer' at next redisplay. You should not normally change this; the function `display-warning' automatically does this at appropriate times.Vinhibit-warning-display Non-nil means inhibit display of warning messages. You should *bind* this, not set it. Any pending warning messages will be displayed when the binding no longer applies.Vleft-margin-width *Width of left margin. This is a specifier; use `set-specifier' to change it.Vright-margin-width *Width of right margin. This is a specifier; use `set-specifier' to change it.Vminimum-line-ascent *Minimum ascent height of lines. This is a specifier; use `set-specifier' to change it.Vminimum-line-descent *Minimum descent height of lines. This is a specifier; use `set-specifier' to change it.Vuse-left-overflow *Non-nil means use the left outside margin as extra whitespace when displaying 'whitespace or 'inside-margin glyphs. This is a specifier; use `set-specifier' to change it.Vuse-right-overflow *Non-nil means use the right outside margin as extra whitespace when displaying 'whitespace or 'inside-margin glyphs. This is a specifier; use `set-specifier' to change it.Vterminal-device The initial device-object, which represent's Emacs's stdout.Vterminal-frame The initial frame-object, which represents Emacs's stdout.Fwindowp Return t if OBJ is a window. arguments: (OBJ) Fwindow-live-p Return t if OBJ is a window which is currently visible. arguments: (OBJ) Fselected-window Return the window that the cursor now appears in and commands apply to. If DEVICE is not specified, the selected device is used. arguments: (&optional DEVICE) Fminibuffer-window Return the window used now for minibuffers. If the optional argument DEV-OR-FRAME is specified and is a frame, return the minibuffer window used by that frame. If DEV-OR-FRAME is a device, then the selected frame on that device will be used. Otherwise, the selected frame on the current device is assumed. arguments: (&optional DEV-OR-FRAME) Fwindow-minibuffer-p Return non-nil if WINDOW is a minibuffer window. arguments: (WINDOW) Fwindow-lowest-p Return non-nil if WINDOW is along the bottom of its frame. arguments: (WINDOW) Fwindow-highest-p Return non-nil if WINDOW is along the top of its frame. arguments: (WINDOW) Fpos-visible-in-window-p Return t if position POS is currently on the frame in WINDOW. Returns nil if that position is scrolled vertically out of view. POS defaults to point in WINDOW's buffer; WINDOW, to the selected window. arguments: (&optional POS WINDOW) Fwindow-buffer Return the buffer that WINDOW is displaying. arguments: (&optional WINDOW) Fwindow-frame Return the frame that window WINDOW is on. arguments: (&optional WINDOW) Fwindow-height Return the number of lines in WINDOW (including its modeline). arguments: (&optional WINDOW) Fwindow-pixel-height Return the height of WINDOW in pixels. Defaults to current window. arguments: (&optional WINDOW) Fwindow-width Return the number of display columns in WINDOW. This is the width that is usable columns available for text in WINDOW. arguments: (&optional WINDOW) Fwindow-pixel-width Return the width of WINDOW in pixels. Defaults to current window. arguments: (&optional WINDOW) Fwindow-hscroll Return the number of columns by which WINDOW is scrolled from left margin. arguments: (&optional WINDOW) Fset-window-hscroll Set number of columns WINDOW is scrolled from left margin to NCOL. NCOL should be zero or positive. arguments: (WINDOW NCOL) Fwindow-pixel-edges Return a list of the pixel edge coordinates of WINDOW. (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame. The frame toolbars and menubars are considered to be outside of this area. arguments: (&optional WINDOW) Fwindow-point Return current value of point in WINDOW. For a nonselected window, this is the value point would have if that window were selected. Note that, when WINDOW is the selected window and its buffer is also currently selected, the value returned is the same as (point). It would be more strictly correct to return the `top-level' value of point, outside of any save-excursion forms. But that is hard to define. arguments: (&optional WINDOW) Fwindow-start Return position at which display currently starts in WINDOW. arguments: (&optional WINDOW) Fwindow-end Return position at which display currently ends in WINDOW. This is updated by redisplay, when it runs to completion. Simply changing the buffer text or setting `window-start' does not update this value. If GUARANTEE is non-nil, then the return value is guaranteed to be the value of window-end at the end of the next full redisplay assuming nothing else changes in the meantime. This function is potentially much slower with this flag set. arguments: (&optional WINDOW GUARANTEE) Fset-window-point Make point value in WINDOW be at position POS in WINDOW's buffer. arguments: (WINDOW POS) Fset-window-start Make display in WINDOW start at position POS in WINDOW's buffer. Optional third arg NOFORCE non-nil inhibits next redisplay from overriding motion of point in order to display at this exact start. arguments: (WINDOW POS &optional NOFORCE) Fwindow-dedicated-p Return WINDOW's dedicated object, usually t or nil. See also `set-window-buffer-dedicated'. arguments: (WINDOW) Fset-window-buffer-dedicated Make WINDOW display BUFFER and be dedicated to that buffer. Then Emacs will not automatically change which buffer appears in WINDOW. If BUFFER is nil, make WINDOW not be dedicated (but don't change which buffer appears in it currently). arguments: (WINDOW BUFFER) Fdelete-window Remove WINDOW from the display. Default is selected window. If window is the only one on the frame, the frame is destroyed. arguments: (&optional WINDOW) Fnext-window Return next window after WINDOW in canonical ordering of windows. If omitted, WINDOW defaults to the selected window. Optional second arg MINIBUF t means count the minibuffer window even if not active. MINIBUF nil or omitted means count the minibuffer iff it is active. MINIBUF neither t nor nil means not to count the minibuffer even if it is active. Several frames may share a single minibuffer; if the minibuffer counts, all windows on all frames that share that minibuffer count too. Therefore, `next-window' can be used to iterate through the set of windows even when the minibuffer is on another frame. If the minibuffer does not count, only windows from WINDOW's frame count. Optional third arg ALL-FRAMES t means include windows on all frames. ALL-FRAMES nil or omitted means cycle within the frames as specified above. ALL-FRAMES = `visible' means include windows on all visible frames. ALL-FRAMES = 0 means include windows on all visible and iconified frames. Anything else means restrict to WINDOW's frame. If you use consistent values for MINIBUF and ALL-FRAMES, you can use `next-window' to iterate through the entire cycle of acceptable windows, eventually ending up back at the window you started with. `previous-window' traverses the same cycle, in the reverse order. arguments: (&optional WINDOW MINIBUF ALL-FRAMES IGNORED) Fprevious-window Return the window preceeding WINDOW in canonical ordering of windows. If omitted, WINDOW defaults to the selected window. Optional second arg MINIBUF t means count the minibuffer window even if not active. MINIBUF nil or omitted means count the minibuffer iff it is active. MINIBUF neither t nor nil means not to count the minibuffer even if it is active. Several frames may share a single minibuffer; if the minibuffer counts, all windows on all frames that share that minibuffer count too. Therefore, `previous-window' can be used to iterate through the set of windows even when the minibuffer is on another frame. If the minibuffer does not count, only windows from WINDOW's frame count Optional third arg ALL-FRAMES t means include windows on all frames. ALL-FRAMES nil or omitted means cycle within the frames as specified above. ALL-FRAMES = `visible' means include windows on all visible frames. ALL-FRAMES = 0 means include windows on all visible and iconified frames. Anything else means restrict to WINDOW's frame. If you use consistent values for MINIBUF and ALL-FRAMES, you can use `previous-window' to iterate through the entire cycle of acceptable windows, eventually ending up back at the window you started with. `next-window' traverses the same cycle, in the reverse order. arguments: (&optional WINDOW MINIBUF ALL-FRAMES IGNORED) Fnext-vertical-window Return the next window which is vertically after WINDOW. arguments: (&optional WINDOW) Fother-window Select the N'th different window on this frame. All windows on current frame are arranged in a cyclic order. This command selects the window N steps away in that order. A negative N moves in the opposite order. If optional argument FRAME is `visible', search all visible frames. If FRAME is 0, search all visible and iconified frames. If FRAME is t, search all frames. If FRAME is nil, search only the selected frame. If FRAME is a frame, search only that frame. arguments: (N &optional FRAME IGNORED) Fget-lru-window Return the window least recently selected or used for display. If optional argument FRAME is `visible', search all visible frames. If FRAME is 0, search all visible and iconified frames. If FRAME is t, search all frames. If FRAME is nil, search only the selected frame. If FRAME is a frame, search only that frame. arguments: (&optional FRAME) Fget-largest-window Return the window largest in area. If optional argument FRAME is `visible', search all visible frames. If FRAME is 0, search all visible and iconified frames. If FRAME is t, search all frames. If FRAME is nil, search only the selected frame. If FRAME is a frame, search only that frame. arguments: (&optional FRAME) Fget-buffer-window Return a window currently displaying BUFFER, or nil if none. If optional argument FRAME is `visible', search all visible frames. If optional argument FRAME is 0, search all visible and iconified frames. If FRAME is t, search all frames. If FRAME is nil, search only the selected frame. If FRAME is a frame, search only that frame. arguments: (BUFFER &optional FRAME IGNORED) Fwindow-left-margin-pixel-width Return the width in pixels of the left outside margin of window WINDOW. If WINDOW is nil, the selected window is assumed. arguments: (&optional WINDOW) Fwindow-right-margin-pixel-width Return the width in pixels of the right outside margin of window WINDOW. If WINDOW is nil, the selected window is assumed. arguments: (&optional WINDOW) Fdelete-other-windows Make WINDOW (or the selected window) fill its frame. Only the frame WINDOW is on is affected. This function tries to reduce display jumps by keeping the text previously visible in WINDOW in the same place on the frame. Doing this depends on the value of (window-start WINDOW), so if calling this function in a program gives strange scrolling, make sure the window-start value is reasonable when this function is called. arguments: (&optional WINDOW) Fdelete-windows-on Delete all windows showing BUFFER. Optional second argument FRAME controls which frames are affected. If nil or omitted, delete all windows showing BUFFER in any frame. If t, delete only windows showing BUFFER in the selected frame. If `visible', delete all windows showing BUFFER in any visible frame. If a frame, delete only windows showing BUFFER in that frame. arguments: (BUFFER &optional FRAME) Freplace-buffer-in-windows Replace BUFFER with some other buffer in all windows showing it. arguments: (BUFFER) Fset-window-buffer Make WINDOW display BUFFER as its contents. BUFFER can be a buffer or buffer name. arguments: (WINDOW BUFFER) Fselect-window Select WINDOW. Most editing will apply to WINDOW's buffer. The main editor command loop selects the buffer of the selected window before each command. arguments: (WINDOW) Fdisplay-buffer Make BUFFER appear in some window on the current frame, but don't select it. BUFFER can be a buffer or a buffer name. If BUFFER is shown already in some window in the current frame, just uses that one, unless the window is the selected window and NOT-THIS-WINDOW-P is non-nil (interactively, with prefix arg). If BUFFER has a dedicated frame, display on that frame instead of the current frame, unless OVERRIDE-FRAME is non-nil. If OVERRIDE-FRAME is non-nil, display on that frame instead of the current frame (or the dedicated frame). If `pop-up-windows' is non-nil, always use the current frame and create a new window regardless of whether the buffer has a dedicated frame, and regardless of whether OVERRIDE-FRAME was specified. Returns the window displaying BUFFER. arguments: (BUFFER &optional NOT-THIS-WINDOW-P OVERRIDE-FRAME) Fsplit-window Split WINDOW, putting SIZE lines in the first of the pair. WINDOW defaults to selected one and SIZE to half its size. If optional third arg HOR-FLAG is non-nil, split side by side and put SIZE columns in the first of the pair. arguments: (&optional WINDOW CHSIZE HORFLAG) Fenlarge-window Make current window ARG lines bigger. From program, optional second arg non-nil means grow sideways ARG columns. arguments: (N &optional SIDE) Fshrink-window Make current window ARG lines smaller. From program, optional second arg non-nil means shrink sideways ARG columns. arguments: (N &optional SIDE) Fscroll-up Scroll text of current window upward ARG lines; or near full screen if no ARG. A near full screen is `next-screen-context-lines' less than a full screen. Negative ARG means scroll downward. When calling from a program, supply a number as argument or nil. arguments: (&optional N) Fscroll-down Scroll text of current window downward ARG lines; or near full screen if no ARG. A near full screen is `next-screen-context-lines' less than a full screen. Negative ARG means scroll upward. When calling from a program, supply a number as argument or nil. arguments: (&optional N) Fother-window-for-scrolling Return the other window for "other window scroll" commands. If in the minibuffer, `minibuffer-scroll-window' if non-nil specifies the window. If `other-window-scroll-buffer' is non-nil, a window showing that buffer is used. arguments: () Fscroll-other-window Scroll next window upward ARG lines; or near full frame if no ARG. The next window is the one below the current one; or the one at the top if the current one is at the bottom. Negative ARG means scroll downward. When calling from a program, supply a number as argument or nil. If in the minibuffer, `minibuf-scroll-window' if non-nil specifies the window to scroll. If `other-window-scroll-buffer' is non-nil, scroll the window showing that buffer, popping the buffer up if necessary. arguments: (&optional N) Fscroll-left Scroll selected window display ARG columns left. Default for ARG is window width minus 2. arguments: (&optional ARG) Fscroll-right Scroll selected window display ARG columns right. Default for ARG is window width minus 2. arguments: (&optional ARG) Frecenter Center point in WINDOW and redisplay frame. With ARG, put point on line ARG. The desired position of point is always relative to the window. Just C-u as prefix means put point in the center of the window. No arg (i.e., it is nil) erases the entire frame and then redraws with point in the center of the window. If WINDOW is nil, the selected window is used. arguments: (&optional N WINDOW) Fmove-to-window-line Position point relative to WINDOW. With no argument, position text at center of window. An argument specifies window line; zero means top of window, negative means relative to bottom of window. If WINDOW is nil, the selected window is used. arguments: (ARG &optional WINDOW) Fwindow-configuration-p T if OBJECT is a window-configuration object. arguments: (OBJ) Fset-window-configuration Set the configuration of windows and buffers as specified by CONFIGURATION. CONFIGURATION must be a value previously returned by `current-window-configuration' (which see). arguments: (CONFIGURATION) Fcurrent-window-configuration Return an object representing the current window configuration of FRAME. If FRAME is nil or omitted, use the selected frame. This describes the number of windows, their sizes and current buffers, and for each displayed buffer, where display starts, and the positions of point and mark. An exception is made for point in the current buffer: its value is -not- saved. arguments: (&optional FRAME) Fsave-window-excursion Execute body, preserving window sizes and contents. Restores which buffer appears in which window, where display starts, as well as the current buffer. Does not restore the value of point in current buffer.Vscroll-on-clipped-lines *Non-nil means to scroll if point lands on a line which is clipped.Vtemp-buffer-show-function Non-nil means call as function to display a help buffer. Used by `with-output-to-temp-buffer'.Vdisplay-buffer-function If non-nil, function to call to handle `display-buffer'. It will receive three args: the same as those to `display-buffer'.Vpre-display-buffer-function If non-nil, function that will be called from `display-buffer' as the first action. It will receive three args: the same as those to `display-buffer'. This function may be used to select an appropriate frame for the buffer, for example. See also the variable `display-buffer-function', which may be used to completely replace the `display-buffer' function.Vminibuffer-scroll-window Non-nil means it is the window that \<minibuffer-local-map>\[scroll-other-window] in minibuffer should scroll.Vother-window-scroll-buffer If non-nil, this is a buffer and \[scroll-other-window] should scroll its window.Vpop-up-windows *Non-nil means display-buffer should make new windows.Vnext-screen-context-lines *Number of lines of continuity when scrolling by screenfuls.Vsplit-height-threshold *display-buffer would prefer to split the largest window if this large. If there is only one window, it is split regardless of this value.Vsplit-width-threshold *display-buffer would prefer to split the largest window if this large. If there is only one window, it is split regardless of this value.Vwindow-min-height *Delete any window less than this tall (including its modeline).Vwindow-min-width *Delete any window less than this wide.Vmodeline-shadow-thickness *How thick to draw 3D shadows around modelines. If this is set to 0, modelines will be the traditional 2D. Sizes above 10 will be accepted but the maximum thickness that will be drawn is 10. This is a specifier; use `set-specifier' to change it.Vhas-modeline-p *Whether the modeline should be displayed. This is a specifier; use `set-specifier' to change it.Fallocate-event Return an empty event structure. WARNING, the event object returned may be a reused one; see the function `deallocate-event'. arguments: () Fdeallocate-event Allow the given event structure to be reused. You MUST NOT use this event object after calling this function with it. You will lose. It is not necessary to call this function, as event objects are garbage-collected like all other objects; however, it may be more efficient to explicitly deallocate events when you are sure that that is safe. arguments: (EVENT) Fcopy-event Make a copy of the given event object. If a second argument is given, the first event is copied into the second and the second is returned. If the second argument is not supplied (or is nil) then a new event will be made as with `allocate-event.' See also the function `deallocate-event'. arguments: (EVENT1 &optional EVENT2) Fevent-to-character Return the closest ASCII approximation to the given event object. If the event isn't a keypress, this returns nil. If the ALLOW-EXTRA-MODIFIERS argument is non-nil, then this is lenient in its translation; it will ignore modifier keys other than control and meta, and will ignore the shift modifier on those characters which have no shifted ASCII equivalent (Control-Shift-A for example, will be mapped to the same ASCII code as Control-A). If the ALLOW-META argument is non-nil, then the Meta modifier will be represented by turning on the high bit of the byte returned; otherwise, nil will be returned for events containing the Meta modifier. If the ALLOW-NON-ASCII argument is non-nil, then characters which are present in the prevailing character set (see the `character-set-property' variable) will be returned as their code in that character set, instead of the return value being restricted to ASCII. Note that specifying both ALLOW-META and ALLOW-NON-ASCII is ambiguous, as both use the high bit; `M-x' and `oslash' will be indistinguishable. arguments: (EVENT &optional ALLOW-EXTRA-MODIFIERS ALLOW-META ALLOW-NON-ASCII) Fcharacter-to-event Converts a numeric ASCII value to an event structure, replete with bucky bits. The character is the first argument, and the event to fill in is the second. This function contains knowledge about what the codes ``mean'' -- for example, the number 9 is converted to the character ``Tab'', not the distinct character ``Control-I''. Note that CH does not have to be a numeric value, but can be a symbol such as 'clear or a list such as '(control backspace). If the optional second argument is an event, it is modified; otherwise, a new event object is created. Optional third arg DEVICE is the device to store in the event; this also affects whether the high bit is interpreted as a meta key. A value of nil means use the selected device but always treat the high bit as meta. Beware that character-to-event and event-to-character are not strictly inverse functions, since events contain much more information than the ASCII character set can encode. arguments: (CH &optional EVENT DEVICE) Feventp True if OBJECT is an event object. arguments: (OBJECT) Fevent-live-p True if OBJECT is an event object that has not been deallocated. arguments: (OBJECT) Fkey-press-event-p True if the argument is a key-press event object. arguments: (OBJ) Fbutton-press-event-p True if the argument is a mouse-button-press event object. arguments: (OBJ) Fbutton-release-event-p True if the argument is a mouse-button-release event object. arguments: (OBJ) Fbutton-event-p True if the argument is a button-press or button-release event object. arguments: (OBJ) Fmotion-event-p True if the argument is a mouse-motion event object. arguments: (OBJ) Fprocess-event-p True if the argument is a process-output event object. arguments: (OBJ) Ftimeout-event-p True if the argument is a timeout event object. arguments: (OBJ) Fmisc-user-event-p True if the argument is a misc-user event object. A misc-user event is a user event that is not a keypress or mouse click; normally this means a menu selection or scrollbar action. arguments: (OBJ) Feval-event-p True if the argument is an `eval' event object. arguments: (OBJ) Fevent-timestamp Return the timestamp of the given event object. arguments: (EVENT) Fevent-key Return the KeySym of the given key-press event. This will be the ASCII code of a printing character, or a symbol. arguments: (EVENT) Fevent-button Return the button-number of the given mouse-button-press event. arguments: (EVENT) Fevent-modifier-bits Return a number representing the modifier keys which were down when the given mouse or keyboard event was produced. See also the function event-modifiers. arguments: (EVENT) Fevent-modifiers Return a list of symbols, the names of the modifier keys which were down when the given mouse or keyboard event was produced. See also the function event-modifier-bits. arguments: (EVENT) Fevent-window-x-pixel Return the X position in pixels of the given mouse event. The value returned is relative to the window the event occurred in. This will signal an error if the event is not a mouse-motion, button-press, or button-release event. See also `event-x-pixel'. arguments: (EVENT) Fevent-window-y-pixel Return the Y position in pixels of the given mouse event. The value returned is relative to the window the event occurred in. This will signal an error if the event is not a mouse-motion, button-press, or button-release event. See also `event-y-pixel'. arguments: (EVENT) Fevent-x-pixel Return the X position in pixels of the given mouse event. The value returned is relative to the frame the event occurred in. This will signal an error if the event is not a mouse-motion, button-press, or button-release event. See also `event-window-x-pixel'. arguments: (EVENT) Fevent-y-pixel Return the Y position in pixels of the given mouse event. The value returned is relative to the frame the event occurred in. This will signal an error if the event is not a mouse-motion, button-press, or button-release event. See also `event-window-y-pixel'. arguments: (EVENT) Fevent-over-text-area-p Given a mouse-motion, button-press, or button-release event, return t if the event is over the text area of a window. Otherwise, return nil. The modeline is not considered to be part of the text area. arguments: (EVENT) Fevent-over-modeline-p Given a mouse-motion, button-press, or button-release event, return t if the event is over the modeline of a window. Otherwise, return nil. arguments: (EVENT) Fevent-over-border-p Given a mouse-motion, button-press, or button-release event, return t if the event is over an internal border. Otherwise, return nil. arguments: (EVENT) Fevent-over-toolbar-p Given a mouse-motion, button-press, or button-release event, return t if the event is over a toolbar. Otherwise, return nil. arguments: (EVENT) Fevent-device Return the device that the given event occurred on. This will be nil for some types of events (e.g. eval events). arguments: (EVENT) Fevent-frame Given a mouse-motion, button-press, or button-release event, return the frame on which that event occurred. This will be nil for non-mouse events. arguments: (EVENT) Fevent-window Given a mouse motion, button press, or button release event, compute and return the window on which that event occurred. This may be nil if the event occurred in the border or over a toolbar. The modeline is considered to be in the window it represents. arguments: (EVENT) Fevent-buffer Given a mouse-motion, button-press, or button-release event, return the buffer on which that event occurred. This will be nil for non-mouse events. If event-over-text-area-p is nil, this will also be nil. arguments: (EVENT) Fevent-point Return the character position of the given mouse-motion, button-press, or button-release event. If the event did not occur over a window, or did not occur over text, then this returns nil. Otherwise, it returns an index into the buffer visible in the event's window. arguments: (EVENT) Fevent-closest-point Return the character position of the given mouse-motion, button-press, or button-release event. If the event did not occur over a window or over text, return the closest point to the location of the event. If the Y pixel position overlaps a window and the X pixel position is to the left of that window, the closest point is the beginning of the line containing the Y position. If the Y pixel position overlaps a window and the X pixel position is to the right of that window, the closest point is the end of the line containing the Y position. If the Y pixel position is above a window, return 0. If it is below a window, return the value of (window-end). arguments: (EVENT) Fevent-x Return the X position of the given mouse-motion, button-press, or button-release event in characters. This is relative to the window the event occurred over. arguments: (EVENT) Fevent-y Return the Y position of the given mouse-motion, button-press, or button-release event in characters. This is relative to the window the event occurred over. arguments: (EVENT) Fevent-glyph-extent If the given mouse-motion, button-press, or button-release event happened on top of a glyph, this returns its extent. Otherwise return nil. arguments: (EVENT) Fevent-over-glyph-p Given a mouse-motion, button-press, or button-release event, return t if the event is over a glyph. Otherwise, return nil. arguments: (EVENT) Fevent-glyph-x-pixel Given a mouse-motion, button-press, or button-release event over a glyph, return the X position of the pointer relative to the upper left of the glyph. If the event is not over a glyph, return nil. arguments: (EVENT) Fevent-glyph-y-pixel Given a mouse-motion, button-press, or button-release event over a glyph, return the Y position of the pointer relative to the upper left of the glyph. If the event is not over a glyph, return nil. arguments: (EVENT) Fevent-toolbar-button If the given mouse-motion, button-press, or button-release event happened on top of a toolbar button, return the button. Otherwise, return nil. arguments: (EVENT) Fevent-process Return the process of the given process-output event. arguments: (EVENT) Fevent-function Return the callback function of the given timeout, misc-user, or eval event. arguments: (EVENT) Fevent-object Return the callback function argument of the given timeout, misc-user, or eval event. arguments: (EVENT) Vcharacter-set-property A symbol used to look up the 8-bit character of a keysym. To convert a keysym symbol to an 8-bit code, as when that key is bound to self-insert-command, we will look up the property that this variable names on the property list of the keysym-symbol. The window- system-specific code will set up appropriate properties and set this variable.Finput-pending-p T if command input is currently available with no waiting. Actually, the value is nil only if we can be sure that no input is available. arguments: () Fadd-timeout Add a timeout, to be signaled after the timeout period has elapsed. SECS is a number of seconds, expressed as an integer or a float. FUNCTION will be called after that many seconds have elapsed, with one argument, the given OBJECT. If the optional RESIGNAL argument is provided, then after this timeout expires, `add-timeout' will automatically be called again with RESIGNAL as the first argument. This function returns an object which is the id number of this particular timeout. You can pass that object to `disable-timeout' to turn off the timeout before it has been signalled. NOTE: Id numbers as returned by this function are in a distinct namespace from those returned by `add-async-timeout'. This means that the same id number could refer to a pending synchronous timeout and a different pending asynchronous timeout, and that you cannot pass an id from `add-timeout' to `disable-async-timeout', or vice-versa. The number of seconds may be expressed as a floating-point number, in which case some fractional part of a second will be used. Caveat: the usable timeout granularity will vary from system to system. Adding a timeout causes a timeout event to be returned by `next-event', and the function will be invoked by `dispatch-event,' so if emacs is in a tight loop, the function will not be invoked until the next call to sit-for or until the return to top-level (the same is true of process filters). If you need to have a timeout executed even when XEmacs is in the midst of running Lisp code, use `add-async-timeout'. WARNING: if you are thinking of calling add-timeout from inside of a callback function as a way of resignalling a timeout, think again. There is a race condition. That's why the RESIGNAL argument exists. arguments: (SECS FUNCTION OBJECT &optional RESIGNAL) Fdisable-timeout Disable a timeout from signalling any more. ID should be a timeout id number as returned by `add-timeout'. If ID corresponds to a one-shot timeout that has already signalled, nothing will happen. It will not work to call this function on an id number returned by `add-async-timeout'. Use `disable-async-timeout' for that. arguments: (ID) Fadd-async-timeout Add an asynchronous timeout, to be signaled after an interval has elapsed. SECS is a number of seconds, expressed as an integer or a float. FUNCTION will be called after that many seconds have elapsed, with one argument, the given OBJECT. If the optional RESIGNAL argument is provided, then after this timeout expires, `add-async-timeout' will automatically be called again with RESIGNAL as the first argument. This function returns an object which is the id number of this particular timeout. You can pass that object to `disable-async-timeout' to turn off the timeout before it has been signalled. NOTE: Id numbers as returned by this function are in a distinct namespace from those returned by `add-timeout'. This means that the same id number could refer to a pending synchronous timeout and a different pending asynchronous timeout, and that you cannot pass an id from `add-async-timeout' to `disable-timeout', or vice-versa. The number of seconds may be expressed as a floating-point number, in which case some fractional part of a second will be used. Caveat: the usable timeout granularity will vary from system to system. Adding an asynchronous timeout causes the function to be invoked as soon as the timeout occurs, even if XEmacs is in the midst of executing some other code. (This is unlike the synchronous timeouts added with `add-timeout', where the timeout will only be signalled when XEmacs is waiting for events, i.e. the next return to top-level or invocation of `sit-for' or related functions.) This means that the function that is called *must* not signal an error or change any global state (e.g. switch buffers or windows) except when locking code is in place to make sure that race conditions don't occur in the interaction between the asynchronous timeout function and other code. Under most circumstances, you should use `add-timeout' instead, as it is much safer. Asynchronous timeouts should only be used when such behavior is really necessary. Asynchronous timeouts are blocked and will not occur when `inhibit-quit' is non-nil. As soon as `inhibit-quit' becomes nil again, any pending asynchronous timeouts will get called immediately. (Multiple occurrences of the same asynchronous timeout are not queued, however.) While the callback function of an asynchronous timeout is invoked, `inhibit-quit' is automatically bound to non-nil, and thus other asynchronous timeouts will be blocked unless the callback function explicitly sets `inhibit-quit' to nil. WARNING: if you are thinking of calling `add-async-timeout' from inside of a callback function as a way of resignalling a timeout, think again. There is a race condition. That's why the RESIGNAL argument exists. arguments: (SECS FUNCTION OBJECT &optional RESIGNAL) Fdisable-async-timeout Disable an asynchronous timeout from signalling any more. ID should be a timeout id number as returned by `add-async-timeout'. If ID corresponds to a one-shot timeout that has already signalled, nothing will happen. It will not work to call this function on an id number returned by `add-timeout'. Use `disable-timeout' for that. arguments: (ID) Fenqueue-eval-event Add an eval event to the back of the eval event queue. When this event is dispatched, FUNCTION (which should be a function of one argument) will be called with OBJECT as its argument. See `next-event' for a description of event types and how events are received. arguments: (FUNCTION OBJECT) Femacs-handle-focus-change internal function--don't call this. arguments: (FRAME-INP-AND-DEV) Fnext-event Return the next available event. Pass this object to `dispatch-event' to handle it. In most cases, you will want to use `next-command-event', which returns the next available "user" event (i.e. keypress, button-press, button-release, or menu selection) instead of this function. If EVENT is non-nil, it should be an event object and will be filled in and returned; otherwise a new event object will be created and returned. If PROMPT is non-nil, it should be a string and will be displayed in the echo area while this function is waiting for an event. The next available event will be -- any events in `unread-command-events' or `unread-command-event'; else -- the next event in the currently executing keyboard macro, if any; else -- an event queued by `enqueue-eval-event', if any; else -- the next available event from the window system or terminal driver. In the last case, this function will block until an event is available. The returned event will be one of the following types: -- a key-press event. -- a button-press or button-release event. -- a misc-user-event, meaning the user selected an item on a menu or used the scrollbar. -- a process event, meaning that output from a subprocess is available. -- a timeout event, meaning that a timeout has elapsed. -- an eval event, which simply causes a function to be executed when the event is dispatched. Eval events are generated by `enqueue-eval-event' or by certain other conditions happening. -- a magic event, indicating that some window-system-specific event happened (such as an focus-change notification) that must be handled synchronously with other events. `dispatch-event' knows what to do with these events. arguments: (&optional EVENT PROMPT) Fnext-command-event Return the next available "user" event. Pass this object to `dispatch-event' to handle it. If EVENT is non-nil, it should be an event object and will be filled in and returned; otherwise a new event object will be created and returned. If PROMPT is non-nil, it should be a string and will be displayed in the echo area while this function is waiting for an event. The event returned will be a keyboard, mouse press, or mouse release event. If there are non-command events available (mouse motion, sub-process output, etc) then these will be executed (with `dispatch-event') and discarded. This function is provided as a convenience; it is equivalent to the lisp code (while (progn (next-event event prompt) (not (or (key-press-event-p event) (button-press-event-p event) (button-release-event-p event) (misc-user-event-p event)))) (dispatch-event event)) arguments: (&optional EVENT PROMPT) Fdiscard-input Discard any pending "user" events. Also cancel any kbd macro being defined. A user event is a key press, button press, button release, or "other-user" event (menu selection or scrollbar action). arguments: () Faccept-process-output Allow any pending output from subprocesses to be read by Emacs. It is read into the process' buffers or given to their filter functions. Non-nil arg PROCESS means do not return until some output has been received from PROCESS. If the second arg is non-nil, it is the maximum number of seconds to wait: this function will return after that much time even if no input has arrived from PROCESS. This argument may be a float, meaning wait some fractional part of a second. If the third arg is non-nil, it is a number of milliseconds that is added to the second arg. (This exists only for compatibility.) Return non-nil iff we received any output before the timeout expired. arguments: (&optional PROCESS TIMEOUT-SECS TIMEOUT-MSECS) Fsleep-for Pause, without updating display, for ARG seconds. ARG may be a float, meaning pause for some fractional part of a second. arguments: (SECONDS) Fsit-for Perform redisplay, then wait ARG seconds or until user input is available. ARG may be a float, meaning a fractional part of a second. Optional second arg non-nil means don't redisplay, just wait for input. Redisplay is preempted as always if user input arrives, and does not happen if input is available before it starts. Value is t if waited the full time with no input arriving. arguments: (SECONDS &optional NODISPLAY) Frecent-keys Return vector of last 100 or so keyboard or mouse button events read. This copies the event objects into a new vector; it is safe to keep and modify them. arguments: () Fdispatch-event Given an event object as returned by `next-event', execute it. Key-press, button-press, and button-release events get accumulated until a complete key sequence (see `read-key-sequence') is reached, at which point the sequence is looked up in the current keymaps and acted upon. Mouse motion events cause the low-level handling function stored in `mouse-motion-handler' to be called. (There are very few circumstances under which you should change this handler. Use `mode-motion-hook' instead.) Menu, timeout, and eval events cause the associated function or handler to be called. Process events cause the subprocess's output to be read and acted upon appropriately (see `start-process'). Magic events are handled as necessary. arguments: (EVENT) Fread-key-sequence Read a sequence of keystrokes or mouse clicks. Returns a vector of the event objects read. The vector and the event objects it contains are freshly created (and will not be side-effected by subsequent calls to this function). The sequence read is sufficient to specify a non-prefix command starting from the current local and global keymaps. A C-g typed while in this function is treated like any other character, and `quit-flag' is not set. First arg PROMPT is a prompt string. If nil, do not prompt specially. If the user selects a menu item while we are prompting for a key-sequence, the returned value will be a vector of a single menu-selection event. An error will be signalled if you pass this value to `lookup-key' or a related function. arguments: (PROMPT) Fthis-command-keys Return a vector of the keyboard or mouse button events that were used to invoke this command. This copies the vector and the events; it is safe to keep and modify them. arguments: () Vecho-keystrokes *Nonzero means echo unfinished commands after this many seconds of pause.Vauto-save-interval *Number of keyboard input characters between auto-saves. Zero means disable autosaving due to number of characters typed. See also the variable `auto-save-timeout'.Vpre-command-hook Function or functions to run before every command. This may examine the `this-command' variable to find out what command is about to be run, or may change it to cause a different command to run. Function on this hook must be careful to avoid signalling errors!Vpost-command-hook Function or functions to run after every command. This may examine the `this-command' variable to find out what command was just executed.Vlast-command-event Last keyboard or mouse button event that was part of a command. This variable is off limits: you may not set its value or modify the event that is its value, as it is destructively modified by `read-key-sequence'. If you want to keep a pointer to this value, you must use `copy-event'.Vlast-command-char If the value of `last-command-event' is a keyboard event, then this is the nearest ASCII equivalent to it. This the the value that `self-insert-command' will put in the buffer. Remember that there is NOT a 1:1 mapping between keyboard events and ASCII characters: the set of keyboard events is much larger, so writing code that examines this variable to determine what key has been typed is bad practice, unless you are certain that it will be one of a small set of characters.Vlast-input-event Last keyboard or mouse button event received. This variable is off limits: you may not set its value or modify the event that is its value, as it is destructively modified by `next-event'. If you want to keep a pointer to this value, you must use `copy-event'.Vlast-input-char If the value of `last-input-event' is a keyboard event, then this is the nearest ASCII equivalent to it. Remember that there is NOT a 1:1 mapping between keyboard events and ASCII characters: the set of keyboard events is much larger, so writing code that examines this variable to determine what key has been typed is bad practice, unless you are certain that it will be one of a small set of characters.Vlast-input-time The time (in seconds since Jan 1, 1970) of the last-command-event, represented as a cons of two 16-bit integers. This is destructively modified, so copy it if you want to keep it.Vunread-command-events List of event objects to be read as next command input events. This can be used to simulate the receipt of events from the user. Normally this is nil.Vunread-command-event Obsolete. Use `unread-command-events' instead.Vlast-command The last command executed. Normally a symbol with a function definition, but can be whatever was found in the keymap, or whatever the variable `this-command' was set to by that command.Vthis-command The command now being executed. The command can set this variable; whatever is put here will be in `last-command' during the following command.Vhelp-char Character to recognize as meaning Help. When it is read, do `(eval help-form)', and display result if it's a string. If the value of `help-form' is nil, this char can be read normally. This can be any form recognized as a single key specifier. To disable the help-char, set it to a negative number.Vhelp-form Form to execute when character help-char is read. If the form returns a string, that string is displayed. If `help-form' is nil, the help char is not recognized.Vprefix-help-command Command to run when `help-char' character follows a prefix key. This command is used only when there is no actual binding for that character after that prefix key.Vkeyboard-translate-table String used as translate table for keyboard input, or nil. Each character is looked up in this string and the contents used instead. If string is of length N, character codes N and up are untranslated. This is the right thing to use only if you are on a dumb tty, as it cannot handle input which cannot be represented as ASCII. If you are running emacs under X, you should do the translations with the `xmodmap' program instead.Vretry-undefined-key-binding-unshifted If a key-sequence which ends with a shifted keystroke is undefined and this variable is non-nil then the command lookup is retried again with the last key unshifted. (e.g. C-X C-F would be retried as C-X C-f.) If lookup still fails, a normal error is signalled.Vlocal-pre-command-hook Buffer-local function or functions to run before every command. This variable is local to each buffer (see also `pre-command-hook'). This may examine the `this-command' variable to find out what command is about to be run, or may change it to cause a different command to run. Function on this hook must be careful to avoid signalling errors!Vlocal-post-command-hook Buffer-local function or functions to run after every command. This variable is local to each buffer (see also `post-command-hook'). This may examine the `this-command' variable to find out what command was just executed.Fstreamp Return non-nil if OBJECT is a stream. arguments: (OBJECT) Fx-set-frame-icon-pixmap Set the icon of the given frame to the given image instance, which should be an image instance object (as returned by `make-image-instance'), a glyph object (as returned by `make-glyph'), or nil. If a glyph object is given, the glyph will be instantiated on the frame to produce an image instance object. If the given image instance has a mask, that will be used as the icon mask; however, not all window managers support this. The window manager is also not required to support color pixmaps, only bitmaps (one plane deep). If the image instance does not have a mask, then the optional third argument may be the image instance to use as the mask (it must be one plane deep). arguments: (FRAME IMAGE-INSTANCE &optional MASK) Fx-set-frame-pointer Set the mouse cursor of FRAME to the given cursor, which should be an object returned by `make-cursor'. arguments: (FRAME CURSOR) Fx-set-scrollbar-pointer Set the mouse cursor of the scrollbars on FRAME to the given cursor, which should be an object returned by `make-cursor'. arguments: (FRAME CURSOR) Fx-window-id Get the ID of the X11 window. This gives us a chance to manipulate the Emacs window from within a different program. Since the ID is an unsigned long, we return it as a string. arguments: (&optional FRAME) Vx-gc-pointer-shape The shape of the mouse-pointer during garbage collection. If this is nil, then the cursor will not be changed, and echo-area messages will be used instead.Vx-scrollbar-pointer-shape Currently under construction. Use `x-set-scrollbar-pointer' instead.Vdefault-x-frame-alist Alist of default frame-creation parameters for X frames. These override what is specified in the resource database and in `default-frame-alist', but are overridden by the arguments to the particular call to `make-frame'. Note: frame parameters are pretty much out-of-fashion. Using the functions `modify-frame-parameters' and `frame-parameters' is definitely out-of-fashion, and soon these functions will be made obsolete. Most uses of the frame parameters below can be replaced more flexibly with uses of a specifier, and soon, all frame parameters will have specifier equivalents. Here is a list of recognized frame parameters (they can be queried and set at any time, except as otherwise noted): window-id The X window ID corresponding to the frame. May be set only at startup, and only if external widget support was compiled in; doing so causes the frame to be created as an "external widget" in another program that uses an existing window in the program rather than creating a new one. initially-unmapped If non-nil, the frame will not be visible when it is created. In this case, you need to call `make-frame-visible' to make the frame appear. popup If non-nil, it should be a frame, and this frame will be created as a "popup" frame whose parent is the given frame. This will make the window manager treat the frame as a dialog box, which may entail doing different things (e.g. not asking for positioning, and not iconifying separate from its parent). inter-line-space Not currently implemented. toolbar-shadow-thickness Thickness of toolbar shadows. background-toolbar-color Color of toolbar background. bottom-toolbar-shadow-color Color of bottom shadows on toolbars. (*Not* specific to the bottom-toolbar.) top-toolbar-shadow-color Color of top shadows on toolbars. (*Not* specifier to the top-toolbar.) scrollbar-height Going to be removed. internal-border-width Width of internal border around text area. border-width Width of external border around text area. top Y position (in pixels) of the upper-left outermost corner of the frame (i.e. the upper-left of the window-manager decorations). left X position (in pixels) of the upper-left outermost corner of the frame (i.e. the upper-left of the window-manager decorations). border-color Color of external border around text area. cursor-color Color of text cursor. unsplittable Not currently implemented. minibuffer Not currently implemented. width See `default-frame-alist'. height See `default-frame-alist'. name See `default-frame-alist'. scrollbar-pointer Doesn't really work. pointer Doesn't really work. See also `default-frame-alist', which specifies parameters which apply to all frames, not just X frames.Fx-selection-reply-timeout-internal arguments: (ARG) Fx-own-selection-internal Assert an X selection of the given TYPE with the given VALUE. TYPE is a symbol, typically PRIMARY, SECONDARY, or CLIPBOARD. VALUE is typically a string, or a cons of two markers, but may be anything that the functions on selection-converter-alist know about. arguments: (SELECTION-NAME SELECTION-VALUE) Fx-get-selection-internal Return text selected from some X window. SELECTION is a symbol, typically PRIMARY, SECONDARY, or CLIPBOARD. TYPE is the type of data desired, typically STRING. arguments: (SELECTION-SYMBOL TARGET-TYPE) Fx-disown-selection-internal If we own the named selection, then disown it (make there be no selection). arguments: (SELECTION &optional TIME) Fx-selection-owner-p Whether the current emacs process owns the given X Selection. The arg should be the name of the selection in question, typically one of the symbols PRIMARY, SECONDARY, or CLIPBOARD. (For convenience, the symbol nil is the same as PRIMARY, and t is the same as SECONDARY.) arguments: (&optional SELECTION) Fx-selection-exists-p Whether there is an owner for the given X Selection. The arg should be the name of the selection in question, typically one of the symbols PRIMARY, SECONDARY, or CLIPBOARD. (For convenience, the symbol nil is the same as PRIMARY, and t is the same as SECONDARY.) arguments: (&optional SELECTION) Fx-get-cutbuffer-internal Return the value of the named cutbuffer (typically CUT_BUFFER0). arguments: (BUFFER) Fx-store-cutbuffer-internal Sets the value of the named cutbuffer (typically CUT_BUFFER0). arguments: (BUFFER STRING) Fx-rotate-cutbuffers-internal Rotate the values of the cutbuffers by the given number of steps; positive means move values forward, negative means backward. arguments: (N) Vselection-converter-alist An alist associating selection-types (such as STRING and TIMESTAMP) with functions. These functions will be called with three args: the name of the selection (typically PRIMARY, SECONDARY, or CLIPBOARD); a desired type to which the selection should be converted; and the local selection value (whatever had been passed to `x-own-selection'). These functions should return the value to send to the X server (typically a string). A return value of nil means that the conversion could not be done. A return value which is the symbol NULL means that a side-effect was executed, and there is no meaningful return value.Vx-lost-selection-hooks A function or functions to be called after the X server has notified us that we have lost the selection. The function(s) will be called with one argument, a symbol naming the selection (typically PRIMARY, SECONDARY, or CLIPBOARD).Vx-sent-selection-hooks A function or functions to be called after we have responded to some other client's request for the value of a selection that we own. The function(s) will be called with four arguments: - the name of the selection (typically PRIMARY, SECONDARY, or CLIPBOARD); - the name of the selection-type which we were requested to convert the selection into before sending (for example, STRING or LENGTH); - and whether we successfully transmitted the selection. We might have failed (and declined the request) for any number of reasons, including being asked for a selection that we no longer own, or being asked to convert into a type that we don't know about or that is inappropriate. This hook doesn't let you change the behavior of emacs's selection replies, it merely informs you that they have happened.Vx-selection-timeout If the selection owner doesn't reply in this many seconds, we give up. A value of 0 means wait as long as necessary. This is initialized from the "*selectionTimeout" resource (which is expressed in milliseconds).Vmodifier-keys-are-sticky *Non-nil makes modifier keys sticky. This means that you can release the modifier key before pressing down the key that you wish to be modified. Although this is non-standard behavior, it is recommended because it reduces the strain on your hand, thus reducing the incidence of the dreaded Emacs-pinky syndrome.Vx-allow-sendevents *Non-nil means to allow synthetic events. Nil means they are ignored. Beware: allowing emacs to process SendEvents opens a big security hole.Vx-debug-events If non-zero, display debug information about events that XEmacs sees. Information is displayed on stderr. Currently defined values are: 1 == non-verbose output 2 == verbose outputFpopup-menu Pop up the given menu. A menu description is a list of menu items, strings, and submenus. The first element of a menu must be a string, which is the name of the menu. This is the string that will be displayed in the parent menu, if any. For toplevel menus, it is ignored. This string is not displayed in the menu itself. If an element of a menu is a string, then that string will be presented in the menu as unselectable text. If an element of a menu is a string consisting solely of hyphens, then that item will be presented as a solid horizontal line. If an element of a menu is a list, it is treated as a submenu. The name of that submenu (the first element in the list) will be used as the name of the item representing this menu on the parent. Otherwise, the element must be a vector, which describes a menu item. A menu item can have any of the following forms: [ "name" callback <active-p> ] [ "name" callback <active-p> "suffix" ] [ "name" callback :<keyword> <value> :<keyword> <value> ... ] The name is the string to display on the menu; it is filtered through the resource database, so it is possible for resources to override what string is actually displayed. If the `callback' of a menu item is a symbol, then it must name a command. It will be invoked with `call-interactively'. If it is a list, then it is evaluated with `eval'. The possible keywords are this: :active <form> Same as <active-p> in the first two forms: the expression is evaluated just before the menu is displayed, and the menu will be selectable only if the result is non-nil. :suffix "string" Same as "suffix" in the second form: the suffix is appended to the displayed name, providing a convenient way of adding the name of a command's ``argument'' to the menu, like ``Kill Buffer NAME''. :keys "string" Normally, the keyboard equivalents of commands in menus are displayed when the `callback' is a symbol. This can be used to specify keys for more complex menu items. It is passed through `substitute-command-keys' first. :style <style> Specifies what kind of object this menu item is: nil A normal menu item. toggle A toggle button. radio A radio button. The only difference between toggle and radio buttons is how they are displayed. But for consistency, a toggle button should be used when there is one option whose value can be turned on or off, and radio buttons should be used when there is a set of mutally exclusive options. When using a group of radio buttons, you should arrange for no more than one to be marked as selected at a time. :selected <form> Meaningful only when STYLE is `toggle' or `radio'. This specifies whether the button will be in the selected or unselected state. For example: [ "Save As..." write-file t ] [ "Revert Buffer" revert-buffer (buffer-modified-p) ] [ "Read Only" toggle-read-only :style toggle :selected buffer-read-only ] See menubar.el for many more examples. arguments: (MENU-DESC &optional EVENT) Fpopup-menu-up-p Return t if a popup menu is up, nil otherwise. See `popup-menu'. arguments: () Fpopup-dialog-box Pop up a dialog box. A dialog box description is a list. The first element of a dialog box must be a string, which is the title or question. The rest of the elements are descriptions of the dialog box's buttons. Each of these is a vector, the syntax of which is essentially the same as that of popup menu items. They may have any of the following forms: [ "name" callback <active-p> ] [ "name" callback <active-p> "suffix" ] [ "name" callback :<keyword> <value> :<keyword> <value> ... ] The name is the string to display on the button; it is filtered through the resource database, so it is possible for resources to override what string is actually displayed. If the `callback' of a button is a symbol, then it must name a command. It will be invoked with `call-interactively'. If it is a list, then it is evaluated with `eval'. One (and only one) of the buttons may be `nil'. This marker means that all following buttons should be flushright instead of flushleft. Though the keyword/value syntax is supported for dialog boxes just as in popup menus, the only keyword which is both meaningful and fully implemented for dialog box buttons is `:active'. arguments: (DBOX-DESC) Vpopup-menu-titles If true, popup menus will have title bars at the top.Fx-resource-p Return non-nil if OBJECT is an X resource object. arguments: (OBJECT) Fx-set-x-resource-type Set the type of RESOURE to TYPE. The new type must be an atom. arguments: (RESOURCE TYPE) Vx-handle-non-fully-specified-fonts If this is true then fonts which do not have all characters specified will be considered to be proportional width even if they are actually fixed-width. If this is not done then characters which are supposed to have 0 width may appear to actually have some width. Note: While setting this to t guarantees correct output in all circumstances, it also causes a noticeable performance hit when using fixed-width fonts. Since most people don't use characters which could cause problems this is set to nil by default.Fcolorize-image-instance Make the image instance be displayed in the given colors. Image instances come in two varieties: bitmaps, which are 1 bit deep which are rendered in the prevailing foreground and background colors; and pixmaps, which are of arbitrary depth (including 1) and which have the colors explicitly specified. This function converts a bitmap to a pixmap. If the image instance was a pixmap already, nothing is done (and nil is returned). Otherwise t is returned. arguments: (IMAGE-INSTANCE FOREGROUND BACKGROUND) Fmake-cursor Creates a new `cursor' object of the specified name. The optional second and third arguments are the foreground and background colors. They may be color name strings or `pixel' objects. The optional fourth argument is the device on which to allocate the cursor (defaults to the selected device). This allocates a new cursor in the X server, and signals an error if the cursor is unknown or cannot be allocated. A cursor name can take many different forms. It can be: - any of the standard cursor names from appendix B of the Xlib manual (also known as the file <X11/cursorfont.h>) minus the XC_ prefix; - the name of a font, and glyph index into it of the form "FONT fontname index [[mask-font] mask-index]"; - the name of a bitmap or pixmap file; - or an image instance object, as returned by `make-image-instance'. If it is an image instance or pixmap file, and that pixmap comes with a mask, then that mask will be used. If it is an image instance, it must have only one plane, since X cursors may only have two colors. If it is a pixmap file, then the file will be read in monochrome. If it is a bitmap file, and if a bitmap file whose name is the name of the cursor with "msk" or "Mask" appended exists, then that second bitmap will be used as the mask. For example, a pair of files might be named "cursor.xbm" and "cursor.xbmmsk". The returned object is a normal, first-class lisp object. The way you `deallocate' the cursor is the way you deallocate any other lisp object: you drop all pointers to it and allow it to be garbage collected. When these objects are GCed, the underlying X data is deallocated as well. arguments: (NAME &optional FG BG DEVICE) Fcursorp Return non-nil if OBJECT is a cursor. arguments: (OBJECT) Fcursor-name Return the name used to allocate the given cursor. arguments: (CURSOR) Fcursor-foreground Return the foreground color of the given cursor, or nil if unspecified. arguments: (CURSOR) Fcursor-background Return the background color of the given cursor, or nil if unspecified. arguments: (CURSOR) Fmake-subwindow Creates a new `x-window' object of size WIDTH x HEIGHT. The default is a window of size 1x1, which is also the minimum allowed window size. Subwindows are per-frame. A buffer being shown in two different frames will only display a subwindow glyph in the frame in which it was actually created. If two windows on the same frame are displaying the buffer then the most recently used window will actually display the window. If the frame is not specified, the selected frame is used. arguments: (&optional WIDTH HEIGHT FRAME) Fchange-subwindow-property For the given SUBWINDOW, set PROPERTY to DATA, which is a string. arguments: (SUBWINDOW PROPERTY DATA) Fsubwindowp Return non-nil if OBJECT is a subwindow. arguments: (OBJECT) Fsubwindow-width Width of SUBWINDOW. arguments: (SUBWINDOW) Fsubwindow-height Height of SUBWINDOW. arguments: (SUBWINDOW) Fsubwindow-xid Return the xid of SUBWINDOW as a number. arguments: (SUBWINDOW) Fresize-subwindow Resize SUBWINDOW to WIDTH x HEIGHT. If a value is nil that parameter is not changed. arguments: (SUBWINDOW &optional WIDTH HEIGHT) Fforce-subwindow-map Generate a Map event for SUBWINDOW. arguments: (SUBWINDOW) Vxpm-color-symbols Definitions of logical color-names used when reading XPM files. Elements of this list should be of the form (COLOR-NAME FORM-TO-EVALUATE). The COLOR-NAME should be a string, which is the name of the color to define; the FORM should evaluate to a `color' specifier object, or a string to be passed to `make-color-instance'. If a loaded XPM file references a symbolic color called COLOR-NAME, it will display as the computed color instead. The default value of this variable defines the logical color names "foreground" and "background" to be the colors of the `default' face.Vx-bitmap-file-path A list of the directories in which X bitmap files may be found. If nil, this is initialized from the "*bitmapFilePath" resource. This is used by the `make-image-instance' function (however, note that if the environment variable XBMLANGPATH is set, it is consulted first).Finvocation-name Return the program name that was used to run XEmacs. Any directory names are omitted. arguments: () Frun-emacs-from-temacs Do not call this. It will reinitialize your XEmacs. You'll be sorry.Fkill-emacs Exit the XEmacs job and kill it. Ask for confirmation, without argument. If ARG is an integer, return ARG as the exit program code. If ARG is a string, stuff it as keyboard input. The value of `kill-emacs-hook', if not void, is a list of functions (of no args), all of which are called before XEmacs is actually killed. arguments: (&optional ARG) Fdump-emacs-data Dump current state of XEmacs into data file FILENAME. This function exists on systems that use HAVE_SHM. arguments: (INTONAME) Fdump-emacs Dump current state of XEmacs into executable file FILENAME. Take symbols from SYMFILE (presumably the file you executed to run XEmacs). This is used in the file `loadup.el' when building XEmacs. Remember to set `command-line-processed' to nil before dumping if you want the dumped XEmacs to process its command line and announce itself normally when it is run. arguments: (INTONAME SYMNAME) Fnoninteractive Non-nil return value means XEmacs is running without interactive terminal. arguments: () Vsuppress-early-error-handler-backtrace Non-nil means early error handler shouldn't print a backtraceVcommand-line-args Args passed by shell to XEmacs, as a list of strings.Vinvocation-name The program name that was used to run XEmacs. Any directory names are omitted.Vinvocation-directory The directory in which the XEmacs executable was found, to run it. The value is simply the program name if that directory's name is not known.Vsystem-type Value is symbol indicating type of operating system you are using.Vsystem-configuration Value is string indicating configuration XEmacs was built for.Vnoninteractive Non-nil means XEmacs is running without interactive terminal.Vemacs-priority Priority for XEmacs to run at. This value is effective only if set before XEmacs is dumped, and only if the XEmacs executable is installed with setuid to permit it to change priority. (XEmacs sets its uid back to the real uid.) Currently, you need to define SET_EMACS_PRIORITY in `config.h' before you compile XEmacs, to enable the code for this feature.Freally-early-error-handler You should almost certainly not be using this. arguments: (X) Frecursive-edit Invoke the editor command loop recursively. To get out of the recursive edit, a command can do `(throw 'exit nil)'; that tells this function to return. Alternately, `(throw 'exit t)' makes this function signal an error. arguments: () Fcommand-loop-1 Invoke the internals of the canonical editor command loop. Don't call this unless you know what you're doing. arguments: () Fopen-dribble-file Start writing all keyboard characters to FILE. arguments: (FILE) Fsuspend-emacs Stop Emacs and return to superior process. You can resume later. On systems that don't have job control, run a subshell instead. If optional arg STUFFSTRING is non-nil, its characters are stuffed to be read as terminal input by Emacs's superior shell. Before suspending, if `suspend-hook' is bound and value is non-nil call the value as a function of no args. Don't suspend if it returns non-nil. Otherwise, suspend normally and after resumption call `suspend-resume-hook' if that is bound and non-nil. Some operating systems cannot stop the Emacs process and resume it later. On such systems, Emacs will start a subshell and wait for it to exit. arguments: (&optional STUFFSTRING) Fset-input-mode Set mode of reading keyboard input. First arg is ignored, for backward compatibility. Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal (no effect except in CBREAK mode). Third arg META t means accept 8-bit input (for a Meta key). META nil means ignore the top bit, on the assumption it is parity. Otherwise, accept 8-bit input and don't use the top bit for Meta. First three arguments only apply to TTY devices. Optional fourth arg QUIT if non-nil specifies character to use for quitting. Optional fifth arg DEVICE specifies device to make changes to; nil means the current device. See also `current-input-mode'. arguments: (IGNORED FLOW META &optional QUIT DEVICE) Fcurrent-input-mode Return information about the way Emacs currently reads keyboard input. Optional arg DEVICE specifies device to return information about; nil means the current device. The value is a list of the form (nil FLOW META QUIT), where FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the terminal; this does not apply if Emacs uses interrupt-driven input. META is t if accepting 8-bit input with 8th bit as Meta flag. META nil means ignoring the top bit, on the assumption it is parity. META is neither t nor nil if accepting 8-bit input and using all 8 bits as the character code. QUIT is the character Emacs currently uses to quit. FLOW, and META are only meaningful for TTY devices. The elements of this list correspond to the arguments of `set-input-mode'. arguments: (&optional DEVICE) Vcommand-loop-level Number of recursive edits in progress.Vdisabled-command-hook Value is called instead of any command that is disabled, i.e. has a non-nil `disabled' property.Vtop-level Form to evaluate when Emacs starts up. Useful to set before you dump a modified Emacs.Vcommand-loop Function or one argument to call to read and process keyboard commands. The passed argument specifies whether or not to handle errors.Fstart-kbd-macro Record subsequent keyboard and menu input, defining a keyboard macro. The commands are recorded even as they are executed. Use \[end-kbd-macro] to finish recording and make the macro available. Use \[name-last-kbd-macro] to give it a permanent name. Non-nil arg (prefix arg) means append to last macro defined; This begins by re-executing that macro as if you typed it again. arguments: (APPEND) Fend-kbd-macro Finish defining a keyboard macro. The definition was started by \[start-kbd-macro]. The macro is now available for use via \[call-last-kbd-macro], or it can be given a name with \[name-last-kbd-macro] and then invoked under that name. With numeric arg, repeat macro now that many times, counting the definition just completed as the first repetition. An argument of zero means repeat until error. arguments: (&optional ARG) Fcall-last-kbd-macro Call the last keyboard macro that you defined with \[start-kbd-macro]. A prefix argument serves as a repeat count. Zero means repeat until error. To make a macro permanent so you can call it even after defining others, use \[name-last-kbd-macro]. arguments: (&optional PREFIX) Fexecute-kbd-macro Execute MACRO as string of editor command characters. If MACRO is a symbol, its function definition is used. COUNT is a repeat count, or nil for once, or 0 for infinite loop. arguments: (MACRO &optional PREFIXARG) Vdefining-kbd-macro Non-nil while a keyboard macro is being defined. Don't set this!Vexecuting-macro Currently executing keyboard macro (a vector of events); nil if none executing.Vexecuting-kbd-macro Currently executing keyboard macro (a vector of events); nil if none executing.Vlast-kbd-macro Last kbd macro defined, as a vector of events; nil if none defined.Fmake-keymap Construct and return a new keymap object. All entries in it are nil, meaning "command undefined". arguments: () Fmake-sparse-keymap Construct and return a new keymap object. All entries in it are nil, meaning "command undefined". The only difference between this function and make-keymap is that this function returns a "smaller" keymap (one that is expected to contain fewer entries). As keymaps dynamically resize, the distinction is not great. arguments: () Fkeymap-parents Return the `parent' keymaps of the given keymap, or nil. The parents of a keymap are searched for keybindings when a key sequence isn't bound in this one. `(current-global-map)' is the default parent of all keymaps. arguments: (KEYMAP) Fset-keymap-parents Sets the `parent' keymaps of the given keymap. The parents of a keymap are searched for keybindings when a key sequence isn't bound in this one. `(current-global-map)' is the default parent of all keymaps. arguments: (KEYMAP PARENTS) Fset-keymap-name Sets the `name' of the KEYMAP to NEW-NAME The name is only a debugging convenience; it is not used except when printing the keymap. arguments: (KEYMAP NEW-NAME) Fset-keymap-prompt Sets the `prompt' of KEYMAP to string NEW-PROMPT, or `nil' if no prompt is desired. The prompt is shown in the echo-area when reading a key-sequence to be looked-up in this keymap. arguments: (KEYMAP NEW-PROMPT) Fkeymap-prompt Return the `prompt' of the given keymap. If non-nil, the prompt is shown in the echo-area when reading a key-sequence to be looked-up in this keymap. arguments: (KEYMAP &optional USE-INHERITED) Fset-keymap-default-binding Sets the default binding of KEYMAP to COMMAND, or `nil' if no default is desired. The default-binding is returned when no other binding for a key-sequence is found in the keymap. If a keymap has a non-nil default-binding, neither the keymap's parents nor the current global map are searched for key bindings. arguments: (KEYMAP COMMAND) Fkeymap-default-binding Return the default binding of KEYMAP, or `nil' if it has none. The default-binding is returned when no other binding for a key-sequence is found in the keymap. If a keymap has a non-nil default-binding, neither the keymap's parents nor the current global map are searched for key bindings. arguments: (KEYMAP) Fkeymapp Return t if ARG is a keymap object. The keymap may be autoloaded first if necessary. arguments: (OBJECT) Fcopy-keymap Return a copy of the keymap KEYMAP. The copy starts out with the same definitions of KEYMAP, but changing either the copy or KEYMAP does not affect the other. Any key definitions that are subkeymaps are recursively copied. arguments: (KEYMAP) Fkeymap-fullness Return the number of bindings in the keymap. arguments: (KEYMAP) Fevent-matches-key-specifier-p Return non-nil if EVENT matches KEY-SPECIFIER. This can be useful, e.g., to determine if the user pressed `help-char' or `quit-char'. arguments: (EVENT KEY-SPECIFIER) Fdefine-key Define key sequence KEYS, in KEYMAP, as DEF. KEYMAP is a keymap object. KEYS is the sequence of keystrokes to bind, described below. DEF is anything that can be a key's definition: nil (means key is undefined in this keymap); a command (a Lisp function suitable for interactive calling); a string or key sequence vector (treated as a keyboard macro); a keymap (to define a prefix key); a symbol; when the key is looked up, the symbol will stand for its function definition, that should at that time be one of the above, or another symbol whose function definition is used, and so on. a cons (STRING . DEFN), meaning that DEFN is the definition (DEFN should be a valid definition in its own right); or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP. Contrary to popular belief, the world is not ASCII. When running under a window manager, Emacs can tell the difference between, for example, the keystrokes control-h, control-shift-h, and backspace. You can, in fact, bind different commands to each of these. A `key sequence' is a set of keystrokes. A `keystroke' is a keysym and some set of modifiers (such as control and meta). A `keysym' is what is printed on the keys on your keyboard. A keysym may be represented by a symbol, or (if and only if it is equivalent to an ASCII character in the range 32 - 255) by its ASCII code. The `A' key may be represented by the symbol `A' or by the number 65. The `break' key may be represented only by the symbol `break'. A keystroke may be represented by a list: the last element of the list is the key (a symbol or number, as above) and the preceding elements are the symbolic names of modifier keys (control, meta, super, hyper, alt, and shift). Thus, the sequence control-b is represented by the forms `(control b)' and `(control 98)'. A keystroke may also be represented by an event object, as returned by the `next-command-event' and `read-key-sequence' functions. Note that in this context, the keystroke `control-b' is *not* represented by the number 2 (the ASCII code for ^B). See below. The `shift' modifier is somewhat of a special case. You should not (and cannot) use `(meta shift a)' to mean `(meta A)', since for characters that have ASCII equivalents, the state of the shift key is implicit in the keysym (a vs. A). You also cannot say `(shift =)' to mean `+', as that sort of thing varies from keyboard to keyboard. The shift modifier is for use only with characters that do not have a second keysym on the same key, such as `backspace' and `tab'. A key sequence is a vector of keystrokes. As a degenerate case, elements of this vector may also be keysyms if they have no modifiers. That is, the `A' keystroke is represented by all of these forms: A 65 (A) (65) [A] [65] [(A)] [(65)] the `control-a' keystroke is represented by these forms: (control A) (control 65) [(control A)] [(control 65)] the key sequence `control-c control-a' is represented by these forms: [(control c) (control a)] [(control 99) (control 65)] Mouse button clicks work just like keypresses: (control button1) means pressing the left mouse button while holding down the control key. [(control c) (shift button3)] means control-c, hold shift, click right. Commands may be bound to the mouse-button up-stroke rather than the down- stroke as well. `button1' means the down-stroke, and `button1up' means the up-stroke. Different commands may be bound to the up and down strokes, though that is probably not what you want, so be careful. For backward compatibility, a key sequence may also be represented by a string. In this case, it represents the key sequence(s) that would produce that sequence of ASCII characters in a purely ASCII world. For example, a string containing the ASCII backspace character, "\^H", would represent two key sequences: `(control h)' and `backspace'. Binding a command to this will actually bind both of those key sequences. Likewise for the following pairs: control h backspace control i tab control m return control j linefeed control [ escape control @ control space After binding a command to two key sequences with a form like (define-key global-map "\^X\^I" 'command-1) it is possible to redefine only one of those sequences like so: (define-key global-map [(control x) (control i)] 'command-2) (define-key global-map [(control x) tab] 'command-3) Of course, all of this applies only when running under a window system. If you're talking to emacs through an ASCII-only channel, you don't get any of these features. arguments: (KEYMAP KEYS DEF) Flookup-key In keymap KEYMAP, look up key-sequence KEYS. Return the definition. Nil is returned if KEYS is unbound. See documentation of `define-key' for valid key definitions and key-sequence specifications. A number is returned if KEYS is "too long"; that is, the leading characters fail to be a valid sequence of prefix characters in KEYMAP. The number is how many characters at the front of KEYS it takes to reach a non-prefix command. arguments: (KEYMAP KEYS &optional ACCEPT-DEFAULT) Fcurrent-keymaps Return a list of the current keymaps that will be searched for bindings. This lists keymaps such as the current local map and the minor-mode maps, but does not list the parents of those keymaps. EVENT-OR-KEYS controls which keymaps will be listed. If EVENT-OR-KEYS is a mouse event (or a vector whose last element is a mouse event), the keymaps for that mouse event will be listed (see `key-binding'). Otherwise, the keymaps for key presses will be listed. arguments: (&optional EVENT-OR-KEYS) Fkey-binding Return the binding for command KEYS in current keymaps. KEYS is a string, a vector of events, or a vector of key-description lists as described in the documentation for the `define-key' function. The binding is probably a symbol with a function definition; see the documentation for `lookup-key' for more information. For key-presses, the order of keymaps searched is: - the `keymap' property of any extent(s) at point; - any applicable minor-mode maps; - the current-local-map of the current-buffer; - the current global map. For mouse-clicks, the order of keymaps searched is: - the current-local-map of the `mouse-grabbed-buffer' if any; - the `keymap' property of any extent(s) at the position of the click; - the modeline-map of the buffer corresponding to the modeline under the mouse (if the click happened over a modeline); - the current-local-map of the buffer under the mouse; - any applicable minor-mode maps; - the current global map. Note that if `overriding-local-map' is non-nil, *only* it and the current global map are searched. arguments: (KEYS &optional ACCEPT-DEFAULT) Fuse-global-map Select KEYMAP as the global keymap. arguments: (KEYMAP) Fuse-local-map Select KEYMAP as the local keymap in BUFFER. If KEYMAP is nil, that means no local keymap. If BUFFER is nil, the current buffer is assumed. arguments: (KEYMAP &optional BUFFER) Fcurrent-local-map Return BUFFER's local keymap, or nil if it has none. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Fcurrent-global-map Return the current global keymap. arguments: () Fmap-keymap Apply FUNCTION to each element of KEYMAP. FUNCTION will be called with two arguments: a key-description list, and the binding. The order in which the elements of the keymap are passed to the function is unspecified. If the function inserts new elements into the keymap, it may or may not be called with them later. No element of the keymap will ever be passed to the function more than once. The function will not be called on elements of this keymap's parents (see the function `keymap-parents') or upon keymaps which are contained within this keymap (multi-character definitions). It will be called on "meta" characters since they are not really two-character sequences. If the optional third argument SORT-FIRST is non-nil, then the elements of the keymap will be passed to the mapper function in a canonical order. Otherwise, they will be passed in hash (that is, random) order, which is faster. arguments: (FUNCTION KEYMAP &optional SORT-FIRST) Faccessible-keymaps Find all keymaps accessible via prefix characters from STARTMAP. Returns a list of elements of the form (KEYS . MAP), where the sequence KEYS starting from STARTMAP gets you to MAP. These elements are ordered so that the KEYS increase in length. The first element is ([] . STARTMAP). An optional argument PREFIX, if non-nil, should be a key sequence; then the value includes only maps for prefixes that start with PREFIX. arguments: (STARTMAP &optional PREFIX) Fkey-description Return a pretty description of key-sequence KEYS. Control characters turn into "C-foo" sequences, meta into "M-foo" spaces are put between sequence elements, etc. arguments: (KEYS) Fsingle-key-description Return a pretty description of command character KEY. Control characters turn into C-whatever, etc. This differs from `text-char-description' in that it returns a description of a key read from the user rather than a character from a buffer. arguments: (KEY) Ftext-char-description Return a pretty description of file-character CHAR. Unprintable characters turn into "^char" or \NNN, depending on the value of the `ctl-arrow' variable. This differs from `single-key-description' in that it returns a description of a character from a buffer rather than a key read from the user. arguments: (CHR) Fwhere-is-internal Return list of keys that invoke DEFINITION in KEYMAPS. KEYMAPS can be either a keymap (meaning search in that keymap and the current global keymap) or a list of keymaps (meaning search in exactly those keymaps and no others). If KEYMAPS is nil, search in the currently applicable maps for EVENT-OR-KEYS (this is equivalent to specifying `(current-keymaps EVENT-OR-KEYS)' as the argument to KEYMAPS). If optional 3rd arg FIRSTONLY is non-nil, return a vector representing the first key sequence found, rather than a list of all possible key sequences. If optional 4th arg NOINDIRECT is non-nil, don't follow indirections to other keymaps or slots. This makes it possible to search for an indirect definition itself. arguments: (DEFINITION &optional KEYMAPS FIRSTONLY NOINDIRECT EVENT-OR-KEYS) Fdescribe-bindings-internal Insert a list of all defined keys and their definitions in MAP. Optional second argument ALL says whether to include even "uninteresting" definitions (ie symbols with a non-nil `suppress-keymap' property. Third argument SHADOW is a list of keymaps whose bindings shadow those of map; if a binding is present in any shadowing map, it is not printed. Fourth argument PREFIX, if non-nil, should be a key sequence; only bindings which start with that key sequence will be printed. Fifth argument MOUSE-ONLY-P says to only print bindings for mouse clicks. arguments: (MAP &optional ALL SHADOW PREFIX MOUSE-ONLY-P) Vmeta-prefix-char Meta-prefix character. This character followed by some character `foo' turns into `Meta-foo'. This can be any form recognized as a single key specifier. To disable the meta-prefix-char, set it to a negative number.Vmouse-grabbed-buffer A buffer which should be consulted first for all mouse activity. When a mouse-clicked it processed, it will first be looked up in the local-map of this buffer, and then through the normal mechanism if there is no binding for that click. This buffer's value of `mode-motion-hook' will be consulted instead of the `mode-motion-hook' of the buffer of the window under the mouse. You should *bind* this, not set it.Voverriding-local-map Keymap that overrides all other local keymaps. If this variable is non-nil, it is used as a keymap instead of the buffer's local map, and the minor mode keymaps and extent-local keymaps. You should *bind* this, not set it.Vkeymap-tick Incremented for each change to any keymap.Fbufferp T if OBJECT is an editor buffer. arguments: (OBJECT) Fbuffer-live-p T if OBJECT is an editor buffer that has not been deleted. arguments: (OBJECT) Fbuffer-list Return a list of all existing live buffers. The order is specific to the selected frame; if the optional FRAME argument is provided, the ordering for that frame is returned instead. If the FRAME argument is t, then the global (non-frame) ordering is returned instead. arguments: (&optional FRAME) Fdecode-buffer Validate BUFFER or if BUFFER is nil, return the current buffer. If BUFFER is a valid buffer or a string representing a valid buffer, the corresponding buffer object will be returned. Otherwise an error will be signaled. arguments: (BUFFER) Fget-buffer Return the buffer named NAME (a string). If there is no live buffer named NAME, return nil. NAME may also be a buffer; if so, the value is that buffer. arguments: (NAME) Fget-file-buffer Return the buffer visiting file FILENAME (a string). If there is no such live buffer, return nil. arguments: (FILENAME) Fget-buffer-create Return the buffer named NAME, or create such a buffer and return it. A new buffer is created if there is no live buffer named NAME. If NAME starts with a space, the new buffer does not keep undo information. If NAME is a buffer instead of a string, then it is the value returned. The value is never nil. arguments: (NAME) Fgenerate-new-buffer-name Return a string that is the name of no existing buffer based on NAME. If there is no live buffer named NAME, then return NAME. Otherwise modify name by appending `<NUMBER>', incrementing NUMBER until an unused name is found, and then return that name. Optional second argument IGNORE specifies a name that is okay to use (if it is in the sequence to be tried) even if a buffer with that name exists. arguments: (NAME &optional IGNORE) Fbuffer-name Return the name of BUFFER, as a string. With no argument or nil as argument, return the name of the current buffer. arguments: (&optional BUFFER) Fbuffer-file-name Return name of file BUFFER is visiting, or nil if none. No argument or nil as argument means use the current buffer. arguments: (&optional BUFFER) Fbuffer-local-variables Return an alist of variables that are buffer-local in BUFFER. Most elements look like (SYMBOL . VALUE), describing one variable. For a symbol that is locally unbound, just the symbol appears in the value. Note that storing new VALUEs in these elements doesn't change the variables. No argument or nil as argument means use current buffer as BUFFER. arguments: (&optional BUFFER) Fbuffer-dedicated-frame Return the frame dedicated to this BUFFER, or nil if there is none. No argument or nil as argument means use current buffer as BUFFER. arguments: (&optional BUFFER) Fset-buffer-dedicated-frame For this BUFFER, set the FRAME dedicated to it. FRAME must be a frame or nil. arguments: (BUFFER FRAME) Fbuffer-modified-p Return t if BUFFER was modified since its file was last read or saved. No argument or nil as argument means use current buffer as BUFFER. arguments: (&optional BUFFER) Fset-buffer-modified-p Mark BUFFER as modified or unmodified according to FLAG. A non-nil FLAG means mark the buffer modified. No argument or nil as BUFFER means use current buffer. arguments: (FLAG &optional BUFFER) Fbuffer-modified-tick Return BUFFER's tick counter, incremented for each change in text. Each buffer has a tick counter which is incremented each time the text in that buffer is changed. It wraps around occasionally. No argument or nil as argument means use current buffer as BUFFER. arguments: (&optional BUFFER) Frename-buffer Change current buffer's name to NAME (a string). If second arg UNIQUE is nil or omitted, it is an error if a buffer named NAME already exists. If UNIQUE is non-nil, come up with a new name using `generate-new-buffer-name'. Interactively, one can set UNIQUE with a prefix argument. Returns the name we actually gave the buffer. This does not change the name of the visited file (if any). arguments: (NAME &optional UNIQUE) Fother-buffer Return most recently selected buffer other than BUFFER. Buffers not visible in windows are preferred to visible buffers, unless optional third argument VISIBLE-OK is non-nil. If no other buffer exists, the buffer `*scratch*' is returned. If BUFFER is omitted or nil, some interesting buffer is returned. The ordering is for this frame; If second optional argument FRAME is provided, then the ordering is for that frame. If the second arg is t, then the global ordering is returned. Note: In FSF Emacs, this function takes two arguments: BUFFER and VISIBLE-OK. arguments: (&optional BUFFER FRAME VISIBLE-OK) Fbuffer-disable-undo Make BUFFER stop keeping undo information. Any undo records it already has are discarded. arguments: (BUFFER) Fbuffer-enable-undo Start keeping undo information for buffer BUFFER. No argument or nil as argument means do this for the current buffer. arguments: (&optional BUFFER) Fkill-buffer Kill the buffer BUFNAME. The argument may be a buffer or may be the name of a buffer. An argument of nil means kill the current buffer. Value is t if the buffer is actually killed, nil if user says no. The value of `kill-buffer-hook' (which may be local to that buffer), if not void, is a list of functions to be called, with no arguments, before the buffer is actually killed. The buffer to be killed is current when the hook functions are called. Any processes that have this buffer as the `process-buffer' are killed with `delete-process'. arguments: (BUFNAME) Fswitch-to-buffer Select buffer BUFNAME in the current window. BUFNAME may be a buffer or a buffer name. Optional second arg NORECORD non-nil means do not put this buffer at the front of the list of recently selected ones. WARNING: This is NOT the way to work on another buffer temporarily within a Lisp program! Use `set-buffer' instead. That avoids messing with the window-buffer correspondences. arguments: (BUFNAME &optional NORECORD) Fpop-to-buffer Select buffer BUFNAME in some window, preferably a different one. If BUFNAME is nil, then some other buffer is chosen. If `pop-up-windows' is non-nil, windows can be split to do this. If optional second arg NOT-THIS-WINDOW-P is non-nil, insist on finding another window even if BUFNAME is already visible in the selected window. If optional third arg is non-nil, it is the frame to pop to this buffer on. arguments: (BUFNAME &optional NOT-THIS-WINDOW-P ON-FRAME) Fcurrent-buffer Return the current buffer as a Lisp object. arguments: () Fset-buffer Make the buffer BUFNAME current for editing operations. BUFNAME may be a buffer or the name of an existing buffer. See also `save-excursion' when you want to make a buffer current temporarily. This function does not display the buffer, so its effect ends when the current command terminates. Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently. arguments: (BUFNAME) Fbarf-if-buffer-read-only Signal a `buffer-read-only' error if the buffer is read-only. Optional argument BUFFER defaults to the current buffer. If optional argument START is non-nil, all extents in the buffer which overlap that part of the buffer are checked to ensure none has a `read-only' property. (Extents that lie completely within the range, however, are not checked.) END defaults to the value of START. If START and END are equal, the range checked is [START, END] (i.e. closed on both ends); otherwise, the range checked is (START, END) (open on both ends), except that extents that lie completely within [START, END] are not checked. See `extent-in-region-p' for a fuller discussion. arguments: (&optional BUFFER START END) Fbury-buffer Put BUFFER at the end of the list of all buffers. There it is the least likely candidate for `other-buffer' to return; thus, the least likely buffer for \[switch-to-buffer] to select by default. If BUFFER is nil or omitted, bury the current buffer. Also, if BUFFER is nil or omitted, remove the current buffer from the selected window if it is displayed there. If BEFORE is non-nil, it specifies a buffer before which BUFFER will be placed, instead of being placed at the end. arguments: (&optional BUFFER BEFORE) Ferase-buffer Delete the entire contents of the BUFFER. Any clipping restriction in effect (see `narrow-to-region') is removed, so the buffer is truly empty after this. BUFFER defaults to the current buffer if omitted. arguments: (&optional BUFFER) Fkill-all-local-variables Switch to Fundamental mode by killing current buffer's local variables. Most local variable bindings are eliminated so that the default values become effective once more. Also, the syntax table is set from `standard-syntax-table', the local keymap is set to nil, and the abbrev table from `fundamental-mode-abbrev-table'. This function also forces redisplay of the modeline. Every function to select a new major mode starts by calling this function. As a special exception, local variables whose names have a non-nil `permanent-local' property are not eliminated by this function. The first thing this function does is run the normal hook `change-major-mode-hook'. arguments: () Vchange-major-mode-hook List of hooks to be run before killing local variables in a buffer. This should be used by by any mode that temporarily alters the contents or the read-only state of the buffer. See also `kill-all-local-variables'.Vfind-file-compare-truenames If this is true, then the find-file command will check the truenames of all visited files when deciding whether a given file is already in a buffer, instead of just the buffer-file-name. This means that if you attempt to visit another file which is a symbolic-link to a file which is already in a buffer, the existing buffer will be found instead of a newly- created one. This works if any component of the pathname (including a non- terminal component) is a symbolic link as well, but doesn't work with hard links (nothing does). See also the variable find-file-use-truenames.Vfind-file-use-truenames If this is true, then a buffer's visited file-name will always be chased back to the real file; it will never be a symbolic link, and there will never be a symbolic link anywhere in its directory path. That is, the buffer-file-name and buffer-file-truename will be equal. This doesn't work with hard links. See also the variable find-file-compare-truenames.Vfind-file-visit-truename An alias for `find-file-use-truenames'. This variable is present for compatibility with FSF Emacs.Vbefore-change-functions List of functions to call before each text change. Two arguments are passed to each function: the positions of the beginning and end of the range of old text to be changed. (For an insertion, the beginning and end are at the same place.) No information is given about the length of the text after the change. Buffer changes made while executing the `before-change-functions' don't call any before-change or after-change functions.Vafter-change-functions List of functions to call after each text change. Three arguments are passed to each function: the positions of the beginning and end of the range of changed text, and the length of the pre-change text replaced by that range. (For an insertion, the pre-change length is zero; for a deletion, that length is the number of characters deleted, and the post-change beginning and end are at the same place.) Buffer changes made while executing `after-change-functions' don't call any before-change or after-change functions.Vbefore-change-function Vafter-change-function Vfirst-change-hook A list of functions to call before changing a buffer which is unmodified. The functions are run using the `run-hooks' function.Vundo-threshold Keep no more undo information once it exceeds this size. This threshold is applied when garbage collection happens. The size is counted as the number of bytes occupied, which includes both saved text and other data.Vundo-high-threshold Don't keep more than this much size of undo information. A command which pushes past this size is itself forgotten. This threshold is applied when garbage collection happens. The size is counted as the number of bytes occupied, which includes both saved text and other data.Vinhibit-read-only *Non-nil means disregard read-only status of buffers or characters. If the value is t, disregard `buffer-read-only' and all `read-only' text properties. If the value is a list, disregard `buffer-read-only' and disregard a `read-only' text property if the property value is a member of the list.Vkill-buffer-query-functions List of functions called with no args to query before killing a buffer.Vdelete-auto-save-files *Non-nil means delete auto-save file when a buffer is saved or killed.Vdefault-modeline-format Default value of `modeline-format' for buffers that don't override it. This is the same as (default-value 'modeline-format).Vdefault-abbrev-mode Default value of `abbrev-mode' for buffers that do not override it. This is the same as (default-value 'abbrev-mode).Vdefault-ctl-arrow Default value of `ctl-arrow' for buffers that do not override it. This is the same as (default-value 'ctl-arrow).Vdefault-display-direction Default display-direction for buffers that do not override it. This is the same as (default-value 'display-direction). Note: This is not yet implemented.Vdefault-truncate-lines Default value of `truncate-lines' for buffers that do not override it. This is the same as (default-value 'truncate-lines).Vdefault-fill-column Default value of `fill-column' for buffers that do not override it. This is the same as (default-value 'fill-column).Vdefault-left-margin Default value of `left-margin' for buffers that do not override it. This is the same as (default-value 'left-margin).Vdefault-tab-width Default value of `tab-width' for buffers that do not override it. This is the same as (default-value 'tab-width).Vdefault-case-fold-search Default value of `case-fold-search' for buffers that don't override it. This is the same as (default-value 'case-fold-search).Vdefault-buffer-file-type Default file type for buffers that do not override it. This is the same as (default-value 'buffer-file-type). The file type is nil for text, t for binary.Vmodeline-format Template for displaying modeline for current buffer. Each buffer has its own value of this variable. Value may be a string, a symbol or a list or cons cell. For a symbol, its value is used (but it is ignored if t or nil). A string appearing directly as the value of a symbol is processed verbatim in that the %-constructs below are not recognized. For a list whose car is a symbol, the symbol's value is taken, and if that is non-nil, the cadr of the list is processed recursively. Otherwise, the caddr of the list (if there is one) is processed. For a list whose car is a string or list, each element is processed recursively and the results are effectively concatenated. For a list whose car is an integer, the cdr of the list is processed and padded (if the number is positive) or truncated (if negative) to the width specified by that number. A string is printed verbatim in the modeline except for %-constructs: (%-constructs are allowed when the string is the entire modeline-format or when it is found in a cons-cell or a list) %b -- print buffer name. %c -- print the current column number. %f -- print visited file name. %* -- print %, * or hyphen. %+ -- print *, % or hyphen. % means buffer is read-only and * means it is modified. For a modified read-only buffer, %* gives % and %+ gives *. %s -- print process status. %l -- print the current line number. %S -- print name of selected frame (only meaningful under X Windows). %p -- print percent of buffer above top of window, or Top, Bot or All. %P -- print percent of buffer above bottom of window, perhaps plus Top, or print Bottom or All. %n -- print Narrow if appropriate. %t -- Under MS-DOS, print T if files is text, B if binary. %[ -- print one [ for each recursive editing level. %] similar. %% -- print %. %- -- print infinitely many dashes. Decimal digits after the % specify field width to which to pad.Vdefault-major-mode *Major mode for new buffers. Defaults to `fundamental-mode'. nil here means use current buffer's major mode.Vfundamental-mode-abbrev-table The abbrev table of mode-specific abbrevs for Fundamental Mode.Vmajor-mode Symbol for current buffer's major mode.Vmode-name Pretty name of current buffer's major mode (a string).Vabbrev-mode Non-nil turns on automatic expansion of abbrevs as they are inserted. Automatically becomes buffer-local when set in any fashion.Vcase-fold-search *Non-nil if searches should ignore case. Automatically becomes buffer-local when set in any fashion.Vfill-column *Column beyond which automatic line-wrapping should happen. Automatically becomes buffer-local when set in any fashion.Vleft-margin *Column for the default indent-line-function to indent to. Linefeed indents to this column in Fundamental mode. Automatically becomes buffer-local when set in any fashion. Do not confuse this with the specifier `left-margin-width'; that controls the size of a margin that is displayed outside of the text area.Vtab-width *Distance between tab stops (for display of tab characters), in columns. Automatically becomes buffer-local when set in any fashion.Vctl-arrow *Non-nil means display control chars with uparrow. Nil means use backslash and octal digits. An integer means characters >= ctl-arrow are assumed to be printable, and will be displayed as a single glyph. Any other value is the same as 160 - the code SPC with the high bit on. The interpretation of this variable is likely to change in the future. Automatically becomes buffer-local when set in any fashion. This variable does not apply to characters whose display is specified in the current display table (if there is one).Vdisplay-direction *Non-nil means lines in the buffer are displayed right to left. Nil means left to right. (Not yet implemented.)Vtruncate-lines *Non-nil means do not display continuation lines; give each line of text one frame line. Automatically becomes buffer-local when set in any fashion. Note that this is overridden by the variable `truncate-partial-width-windows' if that variable is non-nil and this buffer is not full-frame width.Vdefault-directory Name of default directory of current buffer. Should end with slash. Each buffer has its own value of this variable.Vfep-mode *Document me.Vbuffer-file-type *If visited file is text, nil; otherwise, t.Vauto-fill-function Function called (if non-nil) to perform auto-fill. It is called after self-inserting a space at a column beyond `fill-column'. Each buffer has its own value of this variable. NOTE: This variable is not an ordinary hook; It may not be a list of functions.Vbuffer-file-name Name of file visited in current buffer, or nil if not visiting a file. Each buffer has its own value of this variable.Vbuffer-file-truename The real name of the file visited in the current buffer, or nil if not visiting a file. This is the result of passing buffer-file-name to the `truename' function. Every buffer has its own value of this variable. This variable is automatically maintained by the functions that change the file name associated with a buffer.Vbuffer-auto-save-file-name Name of file for auto-saving current buffer, or nil if buffer should not be auto-saved. Each buffer has its own value of this variable.Vbuffer-read-only Non-nil if this buffer is read-only. Each buffer has its own value of this variable.Vbuffer-backed-up Non-nil if this buffer's file has been backed up. Backing up is done before the first time the file is saved. Each buffer has its own value of this variable.Vbuffer-saved-size Length of current buffer when last read in, saved or auto-saved. 0 initially. Each buffer has its own value of this variable.Vselective-display Non-nil enables selective display: Integer N as value means display only lines that start with less than n columns of space. A value of t means, after a ^M, all the rest of the line is invisible. Then ^M's in the file are written into files as newlines. Automatically becomes buffer-local when set in any fashion.Vselective-display-ellipses t means display ... on previous line when a line is invisible. Automatically becomes buffer-local when set in any fashion.Vlocal-abbrev-table Local (mode-specific) abbrev table of current buffer.Voverwrite-mode Non-nil if self-insertion should replace existing text. If non-nil and not `overwrite-mode-binary', self-insertion still inserts at the end of a line, and inserts when point is before a tab, until the tab is filled in. If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. Automatically becomes buffer-local when set in any fashion.Vbuffer-undo-list List of undo entries in current buffer. Recent changes come first; older changes follow newer. An entry (START . END) represents an insertion which begins at position START and ends at position END. An entry (TEXT . POSITION) represents the deletion of the string TEXT from (abs POSITION). If POSITION is positive, point was at the front of the text being deleted; if negative, point was at the end. An entry (t HIGHWORD LOWWORD) indicates that the buffer had been previously unmodified. HIGHWORD and LOWWORD are the high and low 16-bit words of the buffer's modification count at the time. If the modification count of the most recent save is different, this entry is obsolete. An entry of the form POSITION indicates that point was at the buffer location given by the integer. Undoing an entry of this form places point at POSITION. nil marks undo boundaries. The undo command treats the changes between two undo boundaries as a single step to be undone. If the value of the variable is t, undo information is not recorded.Flock-buffer Lock FILE, if current buffer is modified. FILE defaults to current buffer's visited file, or else nothing is done if current buffer isn't visiting a file. arguments: (&optional FN) Funlock-buffer Unlock the file visited in the current buffer, if it should normally be locked. arguments: () Ffile-locked-p Return nil if the FILENAME is not locked, t if it is locked by you, else a string of the name of the locker. arguments: (&optional FN) Vlock-directory Don't change thisVsuperlock-path Don't change thisFmarker-buffer Return the buffer that MARKER points into, or nil if none. Returns nil if MARKER points into a dead buffer. arguments: (MARKER) Fmarker-position Return the position MARKER points at, as a character number. Returns `nil' if marker doesn't point anywhere. arguments: (MARKER) Fset-marker Position MARKER before character number NUMBER in BUFFER. BUFFER defaults to the current buffer. If NUMBER is nil, makes marker point nowhere. Then it no longer slows down editing in any buffer. If this marker was returned by (point-marker t), then changing its position moves point. You cannot change its buffer or make it point nowhere. Returns MARKER. arguments: (MARKER POS &optional BUFFER) Fcopy-marker Return a new marker pointing at the same place as MARKER. If argument is a number, makes a new marker pointing at that position in the current buffer. arguments: (MARKER) Fminibuffer-depth Return current depth of activations of minibuffer, a nonnegative integer. arguments: () Fread-minibuffer-internal Lowest-level interface to minibuffers. Don't call this. arguments: (PROMPT) Ftry-completion Return common substring of all completions of STRING in ALIST. Each car of each element of ALIST is tested to see if it begins with STRING. All that match are compared together; the longest initial sequence common to all matches is returned as a string. If there is no match at all, nil is returned. For an exact match, t is returned. ALIST can be an obarray instead of an alist. Then the print names of all symbols in the obarray are the possible matches. ALIST can also be a function to do the completion itself. It receives three arguments: the values STRING, PREDICATE and nil. Whatever it returns becomes the value of `try-completion'. If optional third argument PREDICATE is non-nil, it is used to test each possible match. The match is a candidate only if PREDICATE returns non-nil. The argument given to PREDICATE is the alist element or the symbol from the obarray. arguments: (STRING ALIST &optional PRED) Fall-completions Search for partial matches to STRING in ALIST. Each car of each element of ALIST is tested to see if it begins with STRING. The value is a list of all the strings from ALIST that match. ALIST can be an obarray instead of an alist. Then the print names of all symbols in the obarray are the possible matches. ALIST can also be a function to do the completion itself. It receives three arguments: the values STRING, PREDICATE and t. Whatever it returns becomes the value of `all-completions'. If optional third argument PREDICATE is non-nil, it is used to test each possible match. The match is a candidate only if PREDICATE returns non-nil. The argument given to PREDICATE is the alist element or the symbol from the obarray. arguments: (STRING ALIST &optional PRED) Vminibuffer-setup-hook Normal hook run just after entry to minibuffer.Vcompletion-ignore-case Non-nil means don't consider case significant in completion.Vcompletion-regexp-list List of regexps that should restrict possible completions.Ffind-file-name-handler Return FILENAME's handler function for OPERATION, if it has one. Otherwise, return nil. A file name is handled if one of the regular expressions in `file-name-handler-alist' matches it. If OPERATION equals `inhibit-file-name-operation', then we ignore any handlers that are members of `inhibit-file-name-handlers', but we still do run any other handlers. This lets handlers use the standard functions without calling themselves recursively. arguments: (FILENAME &optional OPERATION) Ffile-name-directory Return the directory component in file name NAME. Return nil if NAME does not include a directory. Otherwise return a directory spec. Given a Unix syntax file name, returns a string ending in slash; on VMS, perhaps instead a string ending in `:', `]' or `>'. arguments: (FILE) Ffile-name-nondirectory Return file name NAME sans its directory. For example, in a Unix-syntax file name, this is everything after the last slash, or the entire name if it contains no slash. arguments: (FILE) Funhandled-file-name-directory Return a directly usable directory name somehow associated with FILENAME. A `directly usable' directory name is one that may be used without the intervention of any file handler. If FILENAME is a directly usable file itself, return (file-name-directory FILENAME). The `call-process' and `start-process' functions use this function to get a current directory to run processes in. arguments: (FILENAME) Ffile-name-as-directory Return a string representing file FILENAME interpreted as a directory. This operation exists because a directory is also a file, but its name as a directory is different from its name as a file. The result can be used as the value of `default-directory' or passed as second argument to `expand-file-name'. For a Unix-syntax file name, just appends a slash. On VMS, converts "[X]FOO.DIR" to "[X.FOO]", etc. arguments: (FILE) Fdirectory-file-name Return the file name of the directory named DIR. This is the name of the file that holds the data for the directory DIR. This operation exists because a directory is also a file, but its name as a directory is different from its name as a file. In Unix-syntax, this function just removes the final slash. On VMS, given a VMS-syntax directory name such as "[X.Y]", it returns a file name such as "[X]Y.DIR.1". arguments: (DIRECTORY) Fmake-temp-name Generate temporary file name (string) starting with PREFIX (a string). The Emacs process number forms part of the result, so there is no danger of generating a name being used by another process. arguments: (PREFIX) Fexpand-file-name Convert FILENAME to absolute, and canonicalize it. Second arg DEFAULT is directory to start with if FILENAME is relative (does not start with slash); if DEFAULT is nil or missing, the current buffer's value of default-directory is used. Path components that are `.' are removed, and path components followed by `..' are removed, along with the `..' itself; note that these simplifications are done without checking the resulting paths in the file system. An initial `~/' expands to your home directory. An initial `~USER/' expands to USER's home directory. See also the function `substitute-in-file-name'. arguments: (NAME &optional DEFAULT) Ffile-truename Return the canonical name of the given FILE. Second arg DEFAULT is directory to start with if FILE is relative (does not start with slash); if DEFAULT is nil or missing, the current buffer's value of default-directory is used. No component of the resulting pathname will be a symbolic link, as in the realpath() function. arguments: (FILENAME &optional DEFAULT) Fsubstitute-in-file-name Substitute environment variables referred to in FILENAME. `$FOO' where FOO is an environment variable name means to substitute the value of that variable. The variable name should be terminated with a character not a letter, digit or underscore; otherwise, enclose the entire variable name in braces. If `/~' appears, all of FILENAME through that `/' is discarded. On VMS, `$' substitution is not done; this function does little and only duplicates what `expand-file-name' does. arguments: (STRING) Fcopy-file Copy FILE to NEWNAME. Both args must be strings. Signals a `file-already-exists' error if file NEWNAME already exists, unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil. A number as third arg means request confirmation if NEWNAME already exists. This is what happens in interactive use with M-x. Fourth arg KEEP-TIME non-nil means give the new file the same last-modified time as the old one. (This works on only some systems.) A prefix arg makes KEEP-TIME non-nil. arguments: (FILENAME NEWNAME &optional OK-IF-ALREADY-EXISTS KEEP-DATE) Fmake-directory-internal Create a directory. One argument, a file name string. arguments: (DIRNAME) Fdelete-directory Delete a directory. One argument, a file name or directory name string. arguments: (DIRNAME) Fdelete-file Delete specified file. One argument, a file name string. If file has multiple names, it continues to exist with the other names. arguments: (FILENAME) Frename-file Rename FILE as NEWNAME. Both args strings. If file has names other than FILE, it continues to have those names. Signals a `file-already-exists' error if a file NEWNAME already exists unless optional third argument OK-IF-ALREADY-EXISTS is non-nil. A number as third arg means request confirmation if NEWNAME already exists. This is what happens in interactive use with M-x. arguments: (FILENAME NEWNAME &optional OK-IF-ALREADY-EXISTS) Fadd-name-to-file Give FILE additional name NEWNAME. Both args strings. Signals a `file-already-exists' error if a file NEWNAME already exists unless optional third argument OK-IF-ALREADY-EXISTS is non-nil. A number as third arg means request confirmation if NEWNAME already exists. This is what happens in interactive use with M-x. arguments: (FILENAME NEWNAME &optional OK-IF-ALREADY-EXISTS) Fmake-symbolic-link Make a symbolic link to FILENAME, named LINKNAME. Both args strings. Signals a `file-already-exists' error if a file NEWNAME already exists unless optional third argument OK-IF-ALREADY-EXISTS is non-nil. A number as third arg means request confirmation if NEWNAME already exists. This happens for interactive use with M-x. arguments: (FILENAME LINKNAME &optional OK-IF-ALREADY-EXISTS) Fdefine-logical-name Define the job-wide logical name NAME to have the value STRING. If STRING is nil or a null string, the logical name NAME is deleted. arguments: (VARNAME STRING) Fsysnetunam Open a network connection to PATH using LOGIN as the login string. arguments: (PATH LOGIN) Ffile-name-absolute-p Return t if file FILENAME specifies an absolute path name. On Unix, this is a name starting with a `/' or a `~'. arguments: (FILENAME) Ffile-exists-p Return t if file FILENAME exists. (This does not mean you can read it.) See also `file-readable-p' and `file-attributes'. arguments: (FILENAME) Ffile-executable-p Return t if FILENAME can be executed by you. For a directory, this means you can access files in that directory. arguments: (FILENAME) Ffile-readable-p Return t if file FILENAME exists and you can read it. See also `file-exists-p' and `file-attributes'. arguments: (FILENAME) Ffile-symlink-p Return non-nil if file FILENAME is the name of a symbolic link. The value is the name of the file to which it is linked. Otherwise returns nil. arguments: (FILENAME) Ffile-writable-p Return t if file FILENAME can be written or created by you. arguments: (FILENAME) Ffile-directory-p Return t if file FILENAME is the name of a directory as a file. A directory name spec may be given instead; then the value is t if the directory so specified exists and really is a directory. arguments: (FILENAME) Ffile-accessible-directory-p Return t if file FILENAME is the name of a directory as a file, and files in that directory can be opened by you. In order to use a directory as a buffer's current directory, this predicate must return true. A directory name spec may be given instead; then the value is t if the directory so specified exists and really is a readable and searchable directory. arguments: (FILENAME) Ffile-modes Return mode bits of FILE, as an integer. arguments: (FILENAME) Fset-file-modes Set mode bits of FILE to MODE (an integer). Only the 12 low bits of MODE are used. arguments: (FILENAME MODE) Fset-default-file-modes Set the file permission bits for newly created files. MASK should be an integer; if a permission's bit in MASK is 1, subsequently created files will not have that permission enabled. Only the low 9 bits are used. This setting is inherited by subprocesses. arguments: (MODE) Fdefault-file-modes Return the default file protection for created files. The umask value determines which permissions are enabled in newly created files. If a permission's bit in the umask is 1, subsequently created files will not have that permission enabled. arguments: () Funix-sync Tell Unix to finish all pending disk updates. arguments: () Ffile-newer-than-file-p Return t if file FILE1 is newer than file FILE2. If FILE1 does not exist, the answer is nil; otherwise, if FILE2 does not exist, the answer is t. arguments: (FILE1 FILE2) Fcompute-buffer-file-truename Recomputes this buffer's value of `buffer-file-truename' based on the current value of `buffer-file-name'. arguments: () Finsert-file-contents-internal Insert contents of file FILENAME after point. Returns list of absolute file name and length of data inserted. If second argument VISIT is non-nil, the buffer's visited filename and last save file modtime are set, and it is marked unmodified. If visiting and the file does not exist, visiting is completed before the error is signaled. The optional third and fourth arguments BEG and END specify what portion of the file to insert. If VISIT is non-nil, BEG and END must be nil. If optional fifth argument REPLACE is non-nil, it means replace the current buffer contents (in the accessible portion) with the file contents. This is better than simply deleting and inserting the whole thing because (1) it preserves some marker positions and (2) it puts less data in the undo list. If support for Mule exists in this Emacs, code conversion occurs according to the value of `input-coding-system', and `used-coding-system' is set to the coding system actually used. Currently BEG and END refer to byte positions (as opposed to character positions), even in Mule. arguments: (FILENAME &optional VISIT BEG END REPLACE) Fwrite-region-internal Write current region into specified file. When called from a program, takes three arguments: START, END and FILENAME. START and END are buffer positions. Optional fourth argument APPEND if non-nil means append to existing file contents (if any). Optional fifth argument VISIT if t means set the last-save-file-modtime of buffer to this file's modtime and mark buffer not modified. If VISIT is a string, it is a second file name; the output goes to FILENAME, but the buffer is marked as visiting VISIT. VISIT is also the file name to lock and unlock for clash detection. If VISIT is neither t nor nil nor a string, that means do not print the "Wrote file" message. Kludgy feature: if START is a string, then that string is written to the file, instead of any buffer contents, and END is ignored. If support for Mule exists in this Emacs, code conversion occurs according to the value of `output-coding-system'. arguments: (START END FILENAME &optional APPEND VISIT) Fcar-less-than-car Return t if (car A) is numerically less than (car B). arguments: (A B) Fencrypt-string Encrypt STRING using KEY. arguments: (STRING KEY) Fdecrypt-string Decrypt STRING using KEY. arguments: (STRING KEY) Fverify-visited-file-modtime Return t if last mod time of BUF's visited file matches what BUF records. This means that the file has not been changed since it was visited or saved. arguments: (BUF) Fclear-visited-file-modtime Clear out records of last mod time of visited file. Next attempt to save will certainly not complain of a discrepancy. arguments: () Fvisited-file-modtime Return the current buffer's recorded visited file modification time. The value is a list of the form (HIGH . LOW), like the time values that `file-attributes' returns. arguments: () Fset-visited-file-modtime Update buffer's recorded modification time from the visited file's time. Useful if the buffer was not read from the file normally or if the file itself has been changed for some known benign reason. An argument specifies the modification time value to use (instead of that of the visited file), in the form of a list (HIGH . LOW) or (HIGH LOW). arguments: (&optional TIME-LIST) Fset-buffer-modtime Update BUFFER's recorded modification time from the associated file's modtime, if there is an associated file. If not, use the current time. In either case, if the optional arg TIME is supplied, it will be used if it is either an integer or a cons of two integers. arguments: (BUF &optional IN-TIME) Fdo-auto-save Auto-save all buffers that need it. This is all buffers that have auto-saving enabled and are changed since last auto-saved. Auto-saving writes the buffer into a file so that your editing is not lost if the system crashes. This file is not the file you visited; that changes only when you save. Normally we run the normal hook `auto-save-hook' before saving. Non-nil first argument means do not print any message if successful. Non-nil second argument means save only current buffer. arguments: (&optional NO-MESSAGE CURRENT-ONLY) Fset-buffer-auto-saved Mark current buffer as auto-saved with its current text. No auto-save file will be written until the buffer changes again. arguments: () Fclear-buffer-auto-save-failure Clear any record of a recent auto-save failure in the current buffer. arguments: () Frecent-auto-save-p Return t if buffer has been auto-saved since last read in or saved. arguments: () Vvms-stmlf-recfm *Non-nil means write new files with record format `stmlf'. nil means use format `var'. This variable is meaningful only on VMS.Vfile-name-handler-alist *Alist of elements (REGEXP . HANDLER) for file names handled specially. If a file name matches REGEXP, then all I/O on that file is done by calling HANDLER. The first argument given to HANDLER is the name of the I/O primitive to be handled; the remaining arguments are the arguments that were passed to that primitive. For example, if you do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then HANDLER is called like this: (funcall HANDLER 'file-exists-p FILENAME) The function `find-file-name-handler' checks this list for a handler for its argument.Vafter-insert-file-functions A list of functions to be called at the end of `insert-file-contents'. Each is passed one argument, the number of bytes inserted. It should return the new byte count, and leave point the same. If `insert-file-contents' is intercepted by a handler from `file-name-handler-alist', that handler is responsible for calling the after-insert-file-functions if appropriate.Vwrite-region-annotate-functions A list of functions to be called at the start of `write-region'. Each is passed two arguments, START and END as for `write-region'. It should return a list of pairs (POSITION . STRING) of strings to be effectively inserted at the specified positions of the file being written (1 means to insert before the first byte written). The POSITIONs must be sorted into increasing order. If there are several functions in the list, the several lists are merged destructively.Vwrite-region-annotations-so-far When an annotation function is called, this holds the previous annotations. These are the annotations made by other annotation functions that were already called. See also `write-region-annotate-functions'.Vinhibit-file-name-handlers A list of file name handlers that temporarily should not be used. This applies only to the operation `inhibit-file-name-operation'.Vinhibit-file-name-operation The operation for which `inhibit-file-name-handlers' is applicable.Vauto-save-list-file-name File name in which we write a list of all auto save file names.Fdirectory-files Return a list of names of files in DIRECTORY. There are four optional arguments: If FULL is non-nil, absolute pathnames of the files are returned. If MATCH is non-nil, only pathnames containing that regexp are returned. If NOSORT is non-nil, the list is not sorted--its order is unpredictable. NOSORT is useful if you plan to sort the result yourself. If FILES-ONLY is the symbol t, then only the "files" in the directory will be returned; subdirectories will be excluded. If FILES-ONLY is not nil and not t, then only the subdirectories will be returned. Otherwise, if FILES-ONLY is nil (the default) then both files and subdirectories will be returned. arguments: (DIRNAME &optional FULL MATCH NOSORT FILES-ONLY) Ffile-name-completion Complete file name FILE in directory DIR. Returns the longest string common to all filenames in DIR that start with FILE. If there is only one and FILE matches it exactly, returns t. Returns nil if DIR contains no name starting with FILE. Filenames which end with any member of `completion-ignored-extensions' are not considered as possible completions for FILE unless there is no other possible completion. `completion-ignored-extensions' is not applied to the names of directories. arguments: (FILE DIRNAME) Ffile-name-all-completions Return a list of all completions of file name FILE in directory DIR. These are all file names in directory DIR which begin with FILE. Filenames which end with any member of `completion-ignored-extensions' are not considered as possible completions for FILE unless there is no other possible completion. `completion-ignored-extensions' is not applied to the names of directories. arguments: (FILE DIRNAME) Ffile-name-all-versions Return a list of all versions of file name FILE in directory DIR. arguments: (FILE DIRNAME) Ffile-version-limit Return the maximum number of versions allowed for FILE. Returns nil if the file cannot be opened or if there is no version limit. arguments: (FILENAME) Ffile-attributes Return a list of attributes of file FILENAME. Value is nil if specified file cannot be opened. Otherwise, list elements are: 0. t for directory, string (name linked to) for symbolic link, or nil. 1. Number of links to file. 2. File uid. 3. File gid. 4. Last access time, as a list of two integers. First integer has high-order 16 bits of time, second has low 16 bits. 5. Last modification time, likewise. 6. Last status change time, likewise. 7. Size in bytes. (-1, if number is out of range). 8. File modes, as a string of ten letters or dashes as in ls -l. 9. t iff file's gid would change if file were deleted and recreated. 10. inode number. 11. Device number. If file does not exist, returns nil. arguments: (FILENAME) Vcompletion-ignored-extensions *Completion ignores filenames ending in any string in this list. This variable does not affect lists of possible completions, but does affect the commands that actually do completions. It is used by the functions `file-name-completion' and `file-name-all-completions'.Fforward-char Move point right ARG characters (left if ARG negative). On reaching end of buffer, stop and signal error. If BUFFER is nil, the current buffer is assumed. arguments: (&optional ARG BUFFER) Fbackward-char Move point left ARG characters (right if ARG negative). On attempt to pass beginning or end of buffer, stop and signal error. If BUFFER is nil, the current buffer is assumed. arguments: (&optional ARG BUFFER) Fforward-line Move ARG lines forward (backward if ARG is negative). Precisely, if point is on line I, move to the start of line I + ARG. If there isn't room, go as far as possible (no error). Returns the count of lines left to move. If moving forward, that is ARG - number of lines moved; if backward, ARG + number moved. With positive ARG, a non-empty line at the end counts as one line successfully moved (for the return value). If BUFFER is nil, the current buffer is assumed. arguments: (&optional ARG BUFFER) Fbeginning-of-line Move point to beginning of current line. With argument ARG not nil or 1, move forward ARG - 1 lines first. If scan reaches end of buffer, stop there without error. If BUFFER is nil, the current buffer is assumed. arguments: (&optional ARG BUFFER) Fend-of-line Move point to end of current line. With argument ARG not nil or 1, move forward ARG - 1 lines first. If scan reaches end of buffer, stop there without error. If BUFFER is nil, the current buffer is assumed. arguments: (&optional ARG BUFFER) Fdelete-char Delete the following ARG characters (previous, with negative arg). Optional second arg KILLFLAG non-nil means kill instead (save in kill ring). Interactively, ARG is the prefix arg, and KILLFLAG is set if ARG was explicitly specified. arguments: (ARG &optional KILLFLAG) Fdelete-backward-char Delete the previous ARG characters (following, with negative ARG). Optional second arg KILLFLAG non-nil means kill instead (save in kill ring). Interactively, ARG is the prefix arg, and KILLFLAG is set if ARG was explicitly specified. arguments: (ARG &optional KILLFLAG) Fself-insert-command Insert the character you type. Whichever character you type to run this command is inserted. arguments: (ARG) Fnewline Insert a newline. With arg, insert that many newlines. In Auto Fill mode, if no numeric arg, break the preceding line if it's long. arguments: (&optional ARG1) Fself-insert-internal Invoke `self-insert-command' as if CH is entered from keyboard. arguments: (CH) Vblink-paren-function Function called, if non-nil, whenever a close parenthesis is inserted. More precisely, a char with closeparen syntax is self-inserted.Fcase-table-p Return t iff ARG is a case table. See `set-case-table' for more information on these data structures. arguments: (TABLE) Fcurrent-case-table Return the case table of the current buffer. arguments: () Fstandard-case-table Return the standard case table. This is the one used for new buffers. arguments: () Fset-case-table Select a new case table for the current buffer. A case table is a list (DOWNCASE UPCASE CANONICALIZE EQUIVALENCES) where each element is either nil or a string of length 256. DOWNCASE maps each character to its lower-case equivalent. UPCASE maps each character to its upper-case equivalent; if lower and upper case characters are in 1-1 correspondence, you may use nil and the upcase table will be deduced from DOWNCASE. CANONICALIZE maps each character to a canonical equivalent; any two characters that are related by case-conversion have the same canonical equivalent character; it may be nil, in which case it is deduced from DOWNCASE and UPCASE. EQUIVALENCES is a map that cyclicly permutes each equivalence class (of characters with the same canonical equivalent); it may be nil, in which case it is deduced from CANONICALIZE. arguments: (TABLE) Fset-standard-case-table Select a new standard case table for new buffers. See `set-case-table' for more info on case tables. arguments: (TABLE) Vascii-downcase-table String mapping ASCII characters to lowercase equivalents.Vascii-upcase-table String mapping ASCII characters to uppercase equivalents.Fupcase Convert argument to upper case and return that. The argument may be a character or string. The result has the same type. The argument object is not altered. See also `capitalize'. Optional second arg BUFFER specifies which buffer's case tables to use, and defaults to the current buffer. arguments: (OBJ &optional BUFFER) Fdowncase Convert argument to lower case and return that. The argument may be a character or string. The result has the same type. The argument object is not altered. Optional second arg BUFFER specifies which buffer's case tables to use, and defaults to the current buffer. arguments: (OBJ &optional BUFFER) Fcapitalize Convert argument to capitalized form and return that. This means that each word's first character is upper case and the rest is lower case. The argument may be a character or string. The result has the same type. The argument object is not altered. Optional second arg BUFFER specifies which buffer's case tables to use, and defaults to the current buffer. arguments: (OBJ &optional BUFFER) Fupcase-region Convert the region to upper case. In programs, wants two arguments. These arguments specify the starting and ending character numbers of the region to operate on. When used as a command, the text between point and the mark is operated on. See also `capitalize-region'. Optional third arg BUFFER defaults to the current buffer. arguments: (B E &optional BUFFER) Fdowncase-region Convert the region to lower case. In programs, wants two arguments. These arguments specify the starting and ending character numbers of the region to operate on. When used as a command, the text between point and the mark is operated on. Optional third arg BUFFER defaults to the current buffer. arguments: (B E &optional BUFFER) Fcapitalize-region Convert the region to capitalized form. Capitalized form means each word's first character is upper case and the rest of it is lower case. In programs, give two arguments, the starting and ending character positions to operate on. Optional third arg BUFFER defaults to the current buffer. arguments: (B E &optional BUFFER) Fupcase-word Convert following word (or ARG words) to upper case, moving over. With negative argument, convert previous words but do not move. See also `capitalize-word'. Optional second arg BUFFER defaults to the current buffer. arguments: (ARG &optional BUFFER) Fdowncase-word Convert following word (or ARG words) to lower case, moving over. With negative argument, convert previous words but do not move. Optional second arg BUFFER defaults to the current buffer. arguments: (ARG &optional BUFFER) Fcapitalize-word Capitalize the following word (or ARG words), moving over. This gives the word(s) a first character in upper case and the rest lower case. With negative argument, capitalize previous words but do not move. Optional second arg BUFFER defaults to the current buffer. arguments: (ARG &optional BUFFER) Fcurrent-column Return the horizontal position of point. Beginning of line is column 0. This is calculated by adding together the widths of all the displayed representations of the character between the start of the previous line and point. (e.g. control characters will have a width of 2 or 4, tabs will have a variable width.) Ignores finite width of frame, which means that this function may return values greater than (frame-width). Whether the line is visible (if `selective-display' is t) has no effect; however, ^M is treated as end of line when `selective-display' is t. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Findent-to Indent from point with tabs and spaces until COLUMN is reached. Optional second argument MIN says always do at least MIN spaces even if that goes past COLUMN; by default, MIN is zero. If BUFFER is nil, the current buffer is assumed. arguments: (COL &optional MINIMUM BUFFER) Fcurrent-indentation Return the indentation of the current line. This is the horizontal position of the character following any initial whitespace. arguments: (&optional BUFFER) Fmove-to-column Move point to column COLUMN in the current line. The column of a character is calculated by adding together the widths as displayed of the previous characters in the line. This function ignores line-continuation; there is no upper limit on the column number a character can have and horizontal scrolling has no effect. If specified column is within a character, point goes after that character. If it's past end of line, point goes to end of line. A non-nil second (optional) argument FORCE means, if the line is too short to reach column COLUMN then add spaces/tabs to get there, and if COLUMN is in the middle of a tab character, change it to spaces. Returns the actual column that it moved to. arguments: (COLUMN &optional FORCE BUFFER) Fvertical-motion Move to start of frame line LINES lines down. If LINES is negative, this is moving up. Sets point to position found; this may be start of line or just the start of a continuation line. Returns number of lines moved; may be closer to zero than LINES if beginning or end of buffer was reached. Optional second argument is WINDOW to move in. arguments: (LINES &optional WINDOW) Vindent-tabs-mode *Indentation can insert tabs if this is non-nil. Setting this variable automatically makes it local to the current buffer.Flooking-at Return t if text after point matches regular expression PAT. This function modifies the match data that `match-beginning', `match-end' and `match-data' access; save and restore the match data if you want to preserve them. If support for Mule regexps was compiled into this Emacs, and optional second arg BACK is non-nil and PAT is a pre-compiled pattern, PAT is looked backward from point. arguments: (STRING &optional BACK) Fstring-match Return index of start of first match for REGEXP in STRING, or nil. If third arg START is non-nil, start search at that index in STRING. For index of first char beyond the match, do (match-end 0). `match-end' and `match-beginning' also give indices of substrings matched by parenthesis constructs in the pattern. arguments: (REGEXP STRING &optional START) Fskip-chars-forward Move point forward, stopping before a char not in CHARS, or at position LIM. CHARS is like the inside of a `[...]' in a regular expression except that `]' is never special and `\' quotes `^', `-' or `\'. Thus, with arg "a-zA-Z", this skips letters stopping before first nonletter. With arg "^a-zA-Z", skips nonletters stopping before first letter. Returns the distance traveled, either zero or positive. Optional argument BUFFER defaults to the current buffer. arguments: (CHARS &optional LIM BUFFER) Fskip-chars-backward Move point backward, stopping after a char not in CHARS, or at position LIM. See `skip-chars-forward' for details. Returns the distance traveled, either zero or negative. Optional argument BUFFER defaults to the current buffer. arguments: (CHARS &optional LIM BUFFER) Fskip-syntax-forward Move point forward across chars in specified syntax classes. SYNTAX is a string of syntax code characters. Stop before a char whose syntax is not in SYNTAX, or at position LIM. If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX. This function returns the distance traveled, either zero or positive. Optional argument BUFFER defaults to the current buffer. arguments: (SYNTAX &optional LIM BUFFER) Fskip-syntax-backward Move point backward across chars in specified syntax classes. SYNTAX is a string of syntax code characters. Stop on reaching a char whose syntax is not in SYNTAX, or at position LIM. If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX. This function returns the distance traveled, either zero or negative. Optional argument BUFFER defaults to the current buffer. arguments: (SYNTAX &optional LIM BUFFER) Fsearch-backward Search backward from point for STRING. Set point to the beginning of the occurrence found, and return point. An optional second argument bounds the search; it is a buffer position. The match found must not extend before that position. Optional third argument, if t, means if fail just return nil (no error). If not nil and not t, position at limit of search and return nil. Optional fourth argument is repeat count--search for successive occurrences. See also the functions `match-beginning', `match-end' and `replace-match'. arguments: (STRING &optional BOUND NO-ERROR COUNT) Fsearch-forward Search forward from point for STRING. Set point to the end of the occurrence found, and return point. An optional second argument bounds the search; it is a buffer position. The match found must not extend after that position. nil is equivalent to (point-max). Optional third argument, if t, means if fail just return nil (no error). If not nil and not t, move to limit of search and return nil. Optional fourth argument is repeat count--search for successive occurrences. See also the functions `match-beginning', `match-end' and `replace-match'. arguments: (STRING &optional BOUND NO-ERROR COUNT) Fword-search-backward Search backward from point for STRING, ignoring differences in punctuation. Set point to the beginning of the occurrence found, and return point. An optional second argument bounds the search; it is a buffer position. The match found must not extend before that position. Optional third argument, if t, means if fail just return nil (no error). If not nil and not t, move to limit of search and return nil. Optional fourth argument is repeat count--search for successive occurrences. arguments: (STRING &optional BOUND NO-ERROR COUNT) Fword-search-forward Search forward from point for STRING, ignoring differences in punctuation. Set point to the end of the occurrence found, and return point. An optional second argument bounds the search; it is a buffer position. The match found must not extend after that position. Optional third argument, if t, means if fail just return nil (no error). If not nil and not t, move to limit of search and return nil. Optional fourth argument is repeat count--search for successive occurrences. arguments: (STRING &optional BOUND NO-ERROR COUNT) Fre-search-backward Search backward from point for match for regular expression REGEXP. Set point to the beginning of the match, and return point. The match found is the one starting last in the buffer and yet ending before the origin of the search. An optional second argument bounds the search; it is a buffer position. The match found must start at or after that position. Optional third argument, if t, means if fail just return nil (no error). If not nil and not t, move to limit of search and return nil. Optional fourth argument is repeat count--search for successive occurrences. See also the functions `match-beginning', `match-end' and `replace-match'. arguments: (REGEXP &optional BOUND NO-ERROR COUNT) Fre-search-forward Search forward from point for regular expression REGEXP. Set point to the end of the occurrence found, and return point. An optional second argument bounds the search; it is a buffer position. The match found must not extend after that position. Optional third argument, if t, means if fail just return nil (no error). If not nil and not t, move to limit of search and return nil. Optional fourth argument is repeat count--search for successive occurrences. See also the functions `match-beginning', `match-end' and `replace-match'. arguments: (REGEXP &optional BOUND NO-ERROR COUNT) Freplace-match Replace text matched by last search with NEWTEXT. If second arg FIXEDCASE is non-nil, do not alter case of replacement text. Otherwise maybe capitalize the whole text, or maybe just word initials, based on the replaced text. If the replaced text has only capital letters and has at least one multiletter word, convert NEWTEXT to all caps. If the replaced text has at least one word starting with a capital letter, then capitalize each word in NEWTEXT. If third arg LITERAL is non-nil, insert NEWTEXT literally. Otherwise treat `\' as special: `\&' in NEWTEXT means substitute original matched text. `\N' means substitute what matched the Nth `$...$'. If Nth parens didn't match, substitute nothing. `\\' means insert one `\'. `\u' means upcase the next character. `\l' means downcase the next character. `\U' means begin upcasing all following characters. `\L' means begin downcasing all following characters. `\E' means terminate the effect of any `\U' or `\L'. Case changes made with `\u', `\l', `\U', and `\L' override all other case changes that may be made in the replaced text. FIXEDCASE and LITERAL are optional arguments. Leaves point at end of replacement text. arguments: (NEWTEXT &optional FIXEDCASE LITERAL) Fmatch-beginning Return position of start of text matched by last regexp search. NUM, specifies which parenthesized expression in the last regexp. Value is nil if NUMth pair didn't match, or there were less than NUM pairs. Zero means the entire text matched by the whole regexp or whole string. arguments: (NUM) Fmatch-end Return position of end of text matched by last regexp search. NUM specifies which parenthesized expression in the last regexp. Value is nil if NUMth pair didn't match, or there were less than NUM pairs. Zero means the entire text matched by the whole regexp or whole string. arguments: (NUM) Fmatch-data Return a list containing all info on what the last regexp search matched. Element 2N is `(match-beginning N)'; element 2N + 1 is `(match-end N)'. All the elements are markers or nil (nil if the Nth pair didn't match) if the last match was on a buffer; integers or nil if a string was matched. Use `store-match-data' to reinstate the data in this list. arguments: () Fstore-match-data Set internal data on last search match from elements of LIST. LIST should have been created by calling `match-data' previously. arguments: (LIST) Fregexp-quote Return a regexp string which matches exactly STRING and nothing else. arguments: (STR) Fre-compile Compile REGEXP by GNU Emacs original regexp compiler, and return information of the compiled code by a vector of length 11: [ COMPILED-PATTERN (string) RE-NSUB REGS-ALLOCATED CAN-BE-NULL NEWLINE-ANCHOR (integers) NO-SUB NOT-BOL NOT-EOL SYNTAX (integers) FASTMAP TRANSLATE (string) ]. If REGEXP is nil, just return the information of previously compiled code. arguments: (REGEXP) Vforward-word-regexp *Regular expression to be used in forward-word.Vbackward-word-regexp *Regular expression to be used in backward-word.Vregexp-version version number of system internal regexp compiler and interpreter.Fundo-boundary Mark a boundary between units of undo. An undo command will stop at this point, but another undo command will undo to the previous boundary. arguments: () Fprimitive-undo Undo COUNT records from the front of the list LIST. Return what remains of the list. arguments: (COUNT LIST) Fcons Create a new cons, give it CAR and CDR as components, and return it. arguments: (CAR CDR) Flist Return a newly created list with specified arguments as elements. Any number of arguments, even zero arguments, are allowed.Fmake-list Return a newly created list of length LENGTH, with each element being INIT. arguments: (LENGTH INIT) Fmake-vector Return a newly created vector of length LENGTH, with each element being INIT. See also the function `vector'. arguments: (LENGTH INIT) Fvector Return a newly created vector with specified arguments as elements. Any number of arguments, even zero arguments, are allowed.Fmake-byte-code Create a compiled-function object. Usage: (arglist instructions constants stack-size &optional doc-string interactive-spec) Note that, unlike all other emacs-lisp functions, calling this with five arguments is NOT the same as calling it with six arguments, the last of which is nil. If the INTERACTIVE arg is specified as nil, then that means that this function was defined with `(interactive)'. If the arg is not specified, then that means the function is not interactive. This is terrible behavior which is retained for compatibility with old `.elc' files which expected these semantics.Fmake-symbol Return a newly allocated uninterned symbol whose name is NAME. Its value and function definition are void, and its property list is nil. arguments: (STR) Fmake-marker Return a newly allocated marker which does not point at any place. arguments: () Fmake-string Return a newly created string of length LENGTH, with each element being INIT. LENGTH must be an integer and INIT must be a character. arguments: (LENGTH INIT) Fpurecopy Make a copy of OBJECT in pure storage. Recursively copies contents of vectors and cons cells. Does not copy symbols. arguments: (OBJ) Fgarbage-collect Reclaim storage for Lisp objects no longer needed. Returns info on amount of space in use: ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS) (USED-MARKERS . FREE-MARKERS) USED-STRING-CHARS USED-VECTOR-SLOTS PLIST) where `PLIST' is a list of alternating keyword/value pairs providing more detailed information. Garbage collection happens automatically if you cons more than `gc-cons-threshold' bytes of Lisp data since previous garbage collection. arguments: () Fconsing-since-gc Return the number of bytes consed since the last garbage collection. arguments: () Fmemory-limit Return the address of the last byte Emacs has allocated, divided by 1024. This may be helpful in debugging Emacs's memory usage. The value is divided by 1024 to make sure it will fit in a lisp integer. arguments: () Vgc-cons-threshold *Number of bytes of consing between garbage collections. Garbage collection can happen automatically once this many bytes have been allocated since the last garbage collection. All data types count. Garbage collection happens automatically when `eval' or `funcall' are called. (Note that `funcall' is called implicitly as part of evaluation.) By binding this temporarily to a large number, you can effectively prevent garbage collection during a part of the program.Vpure-bytes-used Number of bytes of sharable Lisp data allocated so far.Vdata-bytes-used Number of bytes of unshared memory allocated in this session.Vdata-bytes-free Number of bytes of unshared memory remaining available in this session.Vpurify-flag Non-nil means loading Lisp code in order to dump an executable. This means that certain objects should be allocated in shared (pure) space.Vpre-gc-hook Function or functions to be run just before each garbage collection. Interrupts, garbage collection, and errors are inhibited while this hook runs, so be extremely careful in what you add here. In particular, avoid consing, and do not interact with the user.Vpost-gc-hook Function or functions to be run just after each garbage collection. Interrupts, garbage collection, and errors are inhibited while this hook runs, so be extremely careful in what you add here. In particular, avoid consing, and do not interact with the user.Vgc-message What to display to indicate that a garbage collection is in progress. If this is a string, it is printed in the echo area. If this is a cursor object, the mouse pointer of the selected frame is changed to that cursor for the duration of the garbage collection. See the variable `x-gc-pointer-shape', which is used to control this.Fwrong-type-argument Signal an error until the correct type value is given by the user. This function loops, signalling a continuable `wrong-type-argument' error with PREDICATE and VALUE as the data associated with the error and then calling PREDICATE on the returned value, until the value gotten satisfies PREDICATE. At that point, the gotten value is returned. arguments: (PREDICATE VALUE) Feq T if the two args are the same Lisp object. arguments: (OBJ1 OBJ2) Fnull T if OBJECT is nil. arguments: (OBJECT) Fconsp T if OBJECT is a cons cell. arguments: (OBJECT) Fatom T if OBJECT is not a cons cell. This includes nil. arguments: (OBJECT) Flistp T if OBJECT is a list. This includes nil. arguments: (OBJECT) Fnlistp T if OBJECT is not a list. Lists include nil. arguments: (OBJECT) Fsymbolp T if OBJECT is a symbol. arguments: (OBJECT) Fkeywordp T if OBJECT is a keyword. arguments: (OBJECT) Fvectorp T if OBJECT is a vector. arguments: (OBJECT) Fstringp T if OBJECT is a string. arguments: (OBJECT) Farrayp T if OBJECT is an array (string or vector). arguments: (OBJECT) Fsequencep T if OBJECT is a sequence (list or array). arguments: (OBJECT) Fmarkerp T if OBJECT is a marker (editor pointer). arguments: (OBJECT) Fsubrp T if OBJECT is a built-in function. arguments: (OBJECT) Fsubr-min-args Return minimum number of args built-in function SUBR may be called with. arguments: (SUBR) Fsubr-max-args Return maximum number of args built-in function SUBR may be called with, or nil if it takes an arbitrary number of arguments (or is a special form). arguments: (SUBR) Fcompiled-function-p t if OBJECT is a byte-compiled function object. arguments: (OBJECT) Fcharacterp t if OBJECT is a character. A character is an integer that can be inserted into a buffer with `insert-char'. If Mule support was compiled in, only certain integers are valid characters. Otherwise, all integers are considered valid characters and are modded with 256 to get the actual character to use. arguments: (OBJECT) Fchar-or-string-p t if OBJECT is a character or a string. arguments: (OBJECT) Fintegerp t if OBJECT is an integer. arguments: (OBJECT) Finteger-or-marker-p t if OBJECT is an integer or a marker (editor pointer). arguments: (OBJECT) Fnatnump t if OBJECT is a nonnegative integer. arguments: (OBJECT) Fnumberp t if OBJECT is a number (floating point or integer). arguments: (OBJECT) Fnumber-or-marker-p t if OBJECT is a number or a marker. arguments: (OBJECT) Ffloatp t if OBJECT is a floating point number. arguments: (OBJECT) Ftype-of Return a symbol representing the type of OBJECT. arguments: (OBJECT) Fcar Return the car of CONSCELL. If arg is nil, return nil. Error if arg is not nil and not a cons cell. See also `car-safe'. arguments: (CONSCELL) Fcar-safe Return the car of OBJECT if it is a cons cell, or else nil. arguments: (OBJECT) Fcdr Return the cdr of CONSCELL. If arg is nil, return nil. Error if arg is not nil and not a cons cell. See also `cdr-safe'. arguments: (CONSCELL) Fcdr-safe Return the cdr of OBJECT if it is a cons cell, or else nil. arguments: (OBJECT) Fsetcar Set the car of CONSCELL to be NEWCAR. Returns NEWCAR. arguments: (CONSCELL NEWCAR) Fsetcdr Set the cdr of CONSCELL to be NEWCDR. Returns NEWCDR. arguments: (CONSCELL NEWCDR) Findirect-function Return the function at the end of OBJECT's function chain. If OBJECT is a symbol, follow all function indirections and return the final function binding. If OBJECT is not a symbol, just return it. Signal a void-function error if the final symbol is unbound. Signal a cyclic-function-indirection error if there is a loop in the function chain of symbols. arguments: (OBJECT) Faref Return the element of ARRAY at index INDEX. ARRAY may be a vector or a string, or a byte-code object. INDEX starts at 0. arguments: (ARRAY INDEX) Faset Store into the element of ARRAY at index IDX the value NEWVAL. ARRAY may be a vector or a string. IDX starts at 0. arguments: (ARRAY IDX NEWVAL) Fcompiled-function-instructions Return the byte-opcode string of the compiled-function object. arguments: (FUNCTION) Fcompiled-function-constants Return the constants vector of the compiled-function object. arguments: (FUNCTION) Fcompiled-function-stack-depth Return the max stack depth of the compiled-function object. arguments: (FUNCTION) Fcompiled-function-arglist Return the argument list of the compiled-function object. arguments: (FUNCTION) Fcompiled-function-interactive Return the interactive spec of the compiled-function object, or nil. arguments: (FUNCTION) Fcompiled-function-domain Return the domain of the compiled-function object, or nil. This is only meaningful if I18N3 was enabled when emacs was compiled. arguments: (FUNCTION) F= T if two args, both numbers or markers, are equal. arguments: (NUM1 NUM2) F< T if first arg is less than second arg. Both must be numbers or markers. arguments: (NUM1 NUM2) F> T if first arg is greater than second arg. Both must be numbers or markers. arguments: (NUM1 NUM2) F<= T if first arg is less than or equal to second arg. Both must be numbers or markers. arguments: (NUM1 NUM2) F>= T if first arg is greater than or equal to second arg. Both must be numbers or markers. arguments: (NUM1 NUM2) F/= T if first arg is not equal to second arg. Both must be numbers or markers. arguments: (NUM1 NUM2) Fzerop T if NUMBER is zero. arguments: (NUMBER) Fnumber-to-string Convert NUM to a string by printing it in decimal. Uses a minus sign if negative. NUM may be an integer or a floating point number. arguments: (NUM) Fstring-to-number Convert STRING to a number by parsing it as a decimal number. This parses both integers and floating point numbers. It ignores leading spaces and tabs. arguments: (STRING) F+ Return sum of any number of arguments, which are numbers or markers.F- Negate number or subtract numbers or markers. With one arg, negates it. With more than one arg, subtracts all but the first from the first.F* Return product of any number of arguments, which are numbers or markers.F/ Return first argument divided by all the remaining arguments. The arguments must be numbers or markers.F% Return remainder of first arg divided by second. Both must be integers or markers. arguments: (NUM1 NUM2) Fmod Return X modulo Y. The result falls between zero (inclusive) and Y (exclusive). Both X and Y must be numbers or markers. If either argument is a float, a float will be returned. arguments: (X Y) Fmax Return largest of all the arguments (which must be numbers or markers). The value is always a number; markers are converted to numbers.Fmin Return smallest of all the arguments (which must be numbers or markers). The value is always a number; markers are converted to numbers.Flogand Return bitwise-and of all the arguments. Arguments may be integers, or markers converted to integers.Flogior Return bitwise-or of all the arguments. Arguments may be integers, or markers converted to integers.Flogxor Return bitwise-exclusive-or of all the arguments. Arguments may be integers, or markers converted to integers.Fash Return VALUE with its bits shifted left by COUNT. If COUNT is negative, shifting is actually to the right. In this case, the sign bit is duplicated. arguments: (VALUE COUNT) Flsh Return VALUE with its bits shifted left by COUNT. If COUNT is negative, shifting is actually to the right. In this case, zeros are shifted in on the left. arguments: (VALUE COUNT) F1+ Return NUMBER plus one. NUMBER may be a number or a marker. Markers are converted to integers. arguments: (NUMBER) F1- Return NUMBER minus one. NUMBER may be a number or a marker. Markers are converted to integers. arguments: (NUMBER) Flognot Return the bitwise complement of NUMBER. NUMBER must be an integer. arguments: (NUMBER) Fdocumentation Return the documentation string of FUNCTION. Unless a non-nil second argument is given, the string is passed through `substitute-command-keys'. arguments: (FUNCTION &optional RAW) Fdocumentation-property Return the documentation string that is SYMBOL's PROP property. This is like `get', but it can refer to strings stored in the `exec-directory/DOC' file; and if the value is a string, it is passed through `substitute-command-keys'. A non-nil third argument avoids this translation. arguments: (SYM PROP &optional RAW) FSnarf-documentation Used during Emacs initialization, before dumping runnable Emacs, to find pointers to doc strings stored in `.../lib-src/DOC' and record them in function definitions. One arg, FILENAME, a string which does not include a directory. The file is written to `../lib-src', and later found in `exec-directory' when doc strings are referred to in the dumped Emacs. arguments: (FILENAME) FVerify-documentation Used to make sure everything went well with Snarf-documentation. Writes to stderr if not. arguments: () Fsubstitute-command-keys Substitute key descriptions for command names in STRING. Return a new string which is STRING with substrings of the form \=\[COMMAND] replaced by either: a keystroke sequence that will invoke COMMAND, or "M-x COMMAND" if COMMAND is not on any keys. Substrings of the form \=\{MAPVAR} are replaced by summaries (made by describe-bindings) of the value of MAPVAR, taken as a keymap. Substrings of the form \=\<MAPVAR> specify to use the value of MAPVAR as the keymap for future \=\[COMMAND] substrings. \=\= quotes the following character and is discarded; thus, \=\=\=\= puts \=\= into the output, and \=\=\=\[ puts \=\[ into the output. arguments: (STR) Vinternal-doc-file-name Name of file containing documentation strings of built-in symbols.Fchar-to-string Convert arg CH to a one-character string containing that character. arguments: (CH) Fstring-to-char Convert arg STRING to a character, the first character of that string. arguments: (STR) Fpoint Return value of point, as an integer. Beginning of buffer is position (point-min). If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Fpoint-marker Return value of point, as a marker object. This marker is a copy; you may modify it with reckless abandon. If the argument to this function is non-nil, then it returns the real point-marker; modifying the position of this marker will move point. It is illegal to change the buffer of it, or make it point nowhere. If BUFFER is nil, the current buffer is assumed. arguments: (&optional DONT-COPY-P BUFFER) Fgoto-char Set point to POSITION, a number or marker. Beginning of buffer is position (point-min), end is (point-max). If BUFFER is nil, the current buffer is assumed. Return value of POSITION, as an integer. arguments: (POSITION &optional BUFFER) Fregion-beginning Return position of beginning of region, as an integer. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Fregion-end Return position of end of region, as an integer. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Fmark-marker Return this buffer's mark, as a marker object. If `zmacs-regions' is true, then this returns nil unless the region is currently in the active (highlighted) state. With an argument of t, this returns the mark (if there is one) regardless of the zmacs-region state. You should *generally* not use the mark unless the region is active, if the user has expressed a preference for the zmacs-region model. Watch out! Moving this marker changes the mark position. If you set the marker not to point anywhere, the buffer will have no mark. If BUFFER is nil, the current buffer is assumed. arguments: (&optional INACTIVE-P BUFFER) Fsave-excursion Save point, mark, and current buffer; execute BODY; restore those things. Executes BODY just like `progn'. The values of point, mark and the current buffer are restored even in case of abnormal exit (throw or error).Fbuffer-size Return the number of characters in BUFFER. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Fpoint-min Return the minimum permissible value of point in BUFFER. This is 1, unless narrowing (a buffer restriction) is in effect. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Fpoint-min-marker Return a marker to the minimum permissible value of point in BUFFER. This is the beginning, unless narrowing (a buffer restriction) is in effect. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Fpoint-max Return the maximum permissible value of point in BUFFER. This is (1+ (buffer-size)), unless narrowing (a buffer restriction) is in effect, in which case it is less. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Fpoint-max-marker Return a marker to the maximum permissible value of point BUFFER. This is (1+ (buffer-size)), unless narrowing (a buffer restriction) is in effect, in which case it is less. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Ffollowing-char Return the character following point, as a number. At the end of the buffer or accessible region, return 0. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Fpreceding-char Return the character preceding point, as a number. At the beginning of the buffer or accessible region, return 0. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Fbobp Return T if point is at the beginning of the buffer. If the buffer is narrowed, this means the beginning of the narrowed part. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Feobp Return T if point is at the end of the buffer. If the buffer is narrowed, this means the end of the narrowed part. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Fbolp Return T if point is at the beginning of a line. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Feolp Return T if point is at the end of a line. `End of a line' includes point being at the end of the buffer. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Fchar-after Return character in BUFFER at position POS. POS is an integer or a buffer pointer. If POS is out of range, the value is nil. If BUFFER is nil, the current buffer is assumed. arguments: (POS &optional BUFFER) Fuser-login-name Return the name under which the user logged in, as a string. This is based on the effective uid, not the real uid. Also, if the environment variable LOGNAME or USER is set, that determines the value of this function. If the optional argument UID is present, then environment variables are ignored and this function returns the login name for that UID, or nil. arguments: (&optional UID) Fuser-real-login-name Return the name of the user's real uid, as a string. This ignores the environment variables LOGNAME and USER, so it differs from `user-login-name' when running under `su'. arguments: () Fuser-uid Return the effective uid of Emacs, as an integer. arguments: () Fuser-real-uid Return the real uid of Emacs, as an integer. arguments: () Fuser-full-name Return the full name of the user logged in, as a string. If the optional argument USER is given, then the full name for that user is returned, or nil. USER may be either a login name or a uid. arguments: (&optional USER) Fsystem-name Return the name of the machine you are running on, as a string. arguments: () Femacs-pid Return the process ID of Emacs, as an integer. arguments: () Fcurrent-time Return the current time, as the number of seconds since 12:00 AM January 1970. The time is returned as a list of three integers. The first has the most significant 16 bits of the seconds, while the second has the least significant 16 bits. The third integer gives the microsecond count. The microsecond count is zero on systems that do not provide resolution finer than a second. arguments: () Fcurrent-time-string Return the current time, as a human-readable string. Programs can use this function to decode a time, since the number of columns in each field is fixed. The format is `Sun Sep 16 01:03:52 1973'. If an argument is given, it specifies a time to format instead of the current time. The argument should have the form: (HIGH . LOW) or the form: (HIGH LOW . IGNORED). Thus, you can use times obtained from `current-time' and from `file-attributes'. arguments: (&optional SPECIFIED-TIME) Fcurrent-locale-time-string Return the current time, as a human-readable string. Programs can use this function to decode a time, since the number of columns in each field is fixed. The format is `Sun Sep 16 01:03:52 1973'. If an argument is given, it specifies a time to format instead of the current time. The argument should have the form: (HIGH . LOW) or the form: (HIGH LOW . IGNORED). Thus, you can use times obtained from `current-time' and from `file-attributes'. arguments: (&optional SPECIFIED-TIME) Fcurrent-time-zone Return the offset and name for the local time zone. This returns a list of the form (OFFSET NAME). OFFSET is an integer number of seconds ahead of UTC (east of Greenwich). A negative value means west of Greenwich. NAME is a string giving the name of the time zone. If an argument is given, it specifies when the time zone offset is determined instead of using the current time. The argument should have the form: (HIGH . LOW) or the form: (HIGH LOW . IGNORED). Thus, you can use times obtained from `current-time' and from `file-attributes'. Some operating systems cannot provide all this information to Emacs; in this case, `current-time-zone' returns a list containing nil for the data it can't find. arguments: (&optional SPECIFIED-TIME) Finsert Insert the arguments, either strings or characters, at point. Point moves forward so that it ends up after the inserted text. Any other markers at the point of insertion remain before the text. If a string has non-null string-extent-data, new extents will be created.Finsert-before-markers Insert strings or characters at point, relocating markers after the text. Point moves forward so that it ends up after the inserted text. Any other markers at the point of insertion also end up after the text.Finsert-string Insert STRING into BUFFER at BUFFER's point. Point moves forward so that it ends up after the inserted text. Any other markers at the point of insertion remain before the text. If a string has non-null string-extent-data, new extents will be created. BUFFER defaults to the current buffer. arguments: (STRING &optional BUFFER) Finsert-char Insert COUNT (second arg) copies of CHR (first arg). Point and all markers are affected as in the function `insert'. COUNT defaults to 1 if omitted. The optional third arg BUFFER specifies the buffer to insert the text into. If BUFFER is nil, the current buffer is assumed. arguments: (CHR &optional COUNT BUFFER) Fbuffer-substring Return the contents of part of BUFFER as a string. The two arguments START and END are character positions; they can be in either order. If omitted, they default to the beginning and end of BUFFER, respectively. If there are duplicable extents in the region, the string remembers them in its string-extent-data. If BUFFER is nil, the current buffer is assumed. arguments: (&optional START END BUFFER) Finsert-buffer-substring Insert before point a substring of the contents of buffer BUFFER. BUFFER may be a buffer or a buffer name. Arguments START and END are character numbers specifying the substring. They default to the beginning and the end of BUFFER. arguments: (BUFFER &optional START END) Fcompare-buffer-substrings Compare two substrings of two buffers; return result as number. the value is -N if first string is less after N-1 chars, +N if first string is greater after N-1 chars, or 0 if strings match. Each substring is represented as three arguments: BUFFER, START and END. That makes six args in all, three for each substring. The value of `case-fold-search' in the current buffer determines whether case is significant or ignored. arguments: (BUFFER1 START1 END1 BUFFER2 START2 END2) Fsubst-char-in-region From START to END, replace FROMCHAR with TOCHAR each time it occurs. If optional arg NOUNDO is non-nil, don't record this change for undo and don't mark the buffer as really changed. arguments: (START END FROMCHAR TOCHAR &optional NOUNDO) Ftranslate-region From START to END, translate characters according to TABLE. TABLE is a string; the Nth character in it is the mapping for the character with code N. Returns the number of characters changed. arguments: (START END TABLE) Fdelete-region Delete the text between point and mark. When called from a program, expects two arguments, positions (integers or markers) specifying the stretch to be deleted. If BUFFER is nil, the current buffer is assumed. arguments: (B E &optional BUFFER) Fwiden Remove restrictions (narrowing) from BUFFER. This allows the buffer's full text to be seen and edited. If BUFFER is nil, the current buffer is assumed. arguments: (&optional BUFFER) Fnarrow-to-region Restrict editing in BUFFER to the current region. The rest of the text becomes temporarily invisible and untouchable but is not deleted; if you save the buffer in a file, the invisible text is included in the file. \[widen] makes all visible again. If BUFFER is nil, the current buffer is assumed. See also `save-restriction'. When calling from a program, pass two arguments; positions (integers or markers) bounding the text that should remain visible. arguments: (B E &optional BUFFER) Fsave-restriction Execute BODY, saving and restoring current buffer's restrictions. The buffer's restrictions make parts of the beginning and end invisible. (They are set up with `narrow-to-region' and eliminated with `widen'.) This special form, `save-restriction', saves the current buffer's restrictions when it is entered, and restores them when it is exited. So any `narrow-to-region' within BODY lasts only until the end of the form. The old restrictions settings are restored even in case of abnormal exit (throw or error). The value returned is the value of the last form in BODY. `save-restriction' can get confused if, within the BODY, you widen and then make changes outside the area within the saved restrictions. Note: if you are using both `save-excursion' and `save-restriction', use `save-excursion' outermost: (save-excursion (save-restriction ...))Fformat Format a string out of a control-string and arguments. The first argument is a control string. The other arguments are substituted into it to make the result, a string. It may contain %-sequences meaning to substitute the next argument. %s means print all objects as-is, using `princ'. %S means print all objects as s-expressions, using `prin1'. %d or %i means print as an integer in decimal (%o octal, %x lowercase hex, %X uppercase hex). %c means print as a single character. %f means print as a floating-point number in fixed notation (e.g. 785.200). %e or %E means print as a floating-point number in scientific notation (e.g. 7.85200e+03). %g or %G means print as a floating-point number in "pretty format"; depending on the number, either %f or %e/%E format will be used, and trailing zeroes are removed from the fractional part. The argument used for all but %s and %S must be a number. It will be converted to an integer or a floating-point number as necessary. %$ means reposition to read a specific numbered argument; for example, %3$%s would apply the `%s' and all following format directives to the third argument after the control string. (There must be a positive integer between the % and the $). Zero or more of the flag characters `-', `+', ` ', `0', and `#' may be specified between the optional repositioning spec and the conversion character; see below. An optional minimum field width may be specified after any flag characters and before the conversion character; it specifies the minimum number of characters that the converted argument will take up. Padding will be added on the left (or on the right, if the `-' flag is specified), as necessary. Padding is done with spaces, or with zeroes if the `0' flag is specified. An optional period character and precision may be specified after any minimum field width. It specifies the minimum number of digits to appear in %d, %i, %o, %x, and %X conversions (the number is padded on the left with zeroes as necessary); the number of digits printed after the decimal point for %f, %e, and %E conversions; the number of significant digits printed in %g and %G conversions; and the maximum number of non-padding characters printed in %s and %S conversions. The default precision for floating-point conversions is six. The ` ' and `+' flags mean prefix non-negative numbers with a space or plus sign, respectively. The `#' flag means print numbers in an alternate, more verbose format: octal numbers begin with zero; hex numbers begin with a 0x or 0X; a decimal point is printed in %f, %e, and %E conversions even if no numbers are printed after it; and trailing zeroes are not omitted in %g and %G conversions. Use %% to put a single % into the output.Fchar-equal Return t if two characters match, optionally ignoring case. Both arguments must be characters (i.e. integers). Case is ignored if `case-fold-search' is non-nil in BUFFER. If BUFFER is nil, the current buffer is assumed. arguments: (C1 C2 &optional BUFFER) Ftranspose-regions Transpose region START1 to END1 with START2 to END2. The regions may not be overlapping, because the size of the buffer is never changed in a transposition. Optional fifth arg LEAVE_MARKERS, if non-nil, means don't transpose any markers that happen to be located in the regions. (#### BUG: currently this function always acts as if LEAVE_MARKERS is non-nil.) Transposing beyond buffer boundaries is an error. arguments: (STARTR1 ENDR1 STARTR2 ENDR2 &optional LEAVE-MARKERS) Vzmacs-regions *Whether LISPM-style active regions should be used. This means that commands which operate on the region (the area between the point and the mark) will only work while the region is in the ``active'' state, which is indicated by highlighting. Executing most commands causes the region to not be in the active state, so (for example) \[kill-region] will only work immediately after activating the region. More specifically: - Commands which operate on the region only work if the region is active. - Only a very small set of commands cause the region to become active: Those commands whose semantics are to mark an area, like mark-defun. - The region is deactivated after each command that is executed, except that: - "Motion" commands do not change whether the region is active or not. set-mark-command (C-SPC) pushes a mark and activates the region. Moving the cursor with normal motion commands (C-n, C-p, etc) will cause the region between point and the recently-pushed mark to be highlighted. It will remain highlighted until some non-motion comand is executed. exchange-point-and-mark (\[exchange-point-and-mark]) activates the region. So if you mark a region and execute a command that operates on it, you can reactivate the same region with \[exchange-point-and-mark] (or perhaps \[exchange-point-and-mark] \[exchange-point-and-mark]) to operate on it again. Generally, commands which push marks as a means of navigation (like beginning-of-buffer and end-of-buffer (M-< and M->)) do not activate the region. But commands which push marks as a means of marking an area of text (like mark-defun (\[mark-defun]), mark-word (\[mark-word]) or mark-whole-buffer (\[mark-whole-buffer])) do activate the region. The way the command loop actually works with regard to deactivating the region is as follows: - If the variable `zmacs-region-stays' has been set to t during the command just executed, the region is left alone (this is how the motion commands make the region stay around; see the `_' flag in the `interactive' specification). `zmacs-region-stays' is reset to nil before each command is executed. - If the function `zmacs-activate-region' has been called during the command just executed, the region is left alone. Very few functions should actually call this function. - Otherwise, if the region is active, the region is deactivated and the `zmacs-deactivate-region-hook' is called.Vzmacs-region-active-p Do not alter this. It is for internal use only.Vzmacs-region-stays Commands which do not wish to affect whether the region is currently highlighted should set this to t. Normally, the region is turned off after executing each command that did not explicitly turn it on with the function zmacs-activate-region. Setting this to true lets a command be non-intrusive. See the variable `zmacs-regions'.Vatomic-extent-goto-char-p Do not use this -- it will be going away soon. Indicates if `goto-char' has just been run. This information is allegedly needed to get the desired behavior for atomic extents and unfortunately is not available by any other means.Finteractive Specify a way of parsing arguments for interactive use of a function. For example, write (defun foo (arg) "Doc string" (interactive "p") ...use arg...) to make ARG be the prefix argument when `foo' is called as a command. The "call" to `interactive' is actually a declaration rather than a function; it tells `call-interactively' how to read arguments to pass to the function. When actually called, `interactive' just returns nil. The argument of `interactive' is usually a string containing a code letter followed by a prompt. (Some code letters do not use I/O to get the argument and do not need prompts.) To prompt for multiple arguments, give a code letter, its prompt, a newline, and another code letter, etc. Prompts are passed to format, and may use % escapes to print the arguments that have already been read. If the argument is not a string, it is evaluated to get a list of arguments to pass to the function. Just `(interactive)' means pass no args when calling interactively. Code letters available are: a -- Function name: symbol with a function definition. b -- Name of existing buffer. B -- Name of buffer, possibly nonexistent. c -- Character. C -- Command name: symbol with interactive function definition. d -- Value of point as number. Does not do I/O. D -- Directory name. e -- Last mouse event. Does not do I/O. f -- Existing file name. F -- Possibly nonexistent file name. i -- Always nil. Does not do I/O. k -- Key sequence (a vector of events). m -- Value of mark as number. Does not do I/O. n -- Number read using minibuffer. N -- Prefix arg converted to number, or if none, do like code `n'. p -- Prefix arg converted to number. Does not do I/O. P -- Prefix arg in raw form. Does not do I/O. r -- Region: point and mark as 2 numeric args, smallest first. Does no I/O. s -- Any string. S -- Any symbol. v -- Variable name: symbol that is user-variable-p. x -- Lisp expression read but not evaluated. X -- Lisp expression read and evaluated. z -- Coding system. Z -- Coding system, nil if no prefix arg. In addition, if the string begins with `*' then an error is signaled if the buffer is read-only. This happens before reading any arguments. If the string begins with `@', then the window the mouse is over is selected before anything else is done. If the string begins with `_', then this command will not cause the region to be deactivated when it completes; that is, `zmacs-region-stays' will be set to t when the command exits successfully. You may use any of `@', `*' and `_' at the beginning of the string; they are processed in the order that they appear.Fcall-interactively Call FUNCTION, reading args according to its interactive calling specs. The function contains a specification of how to do the argument reading. In the case of user-defined functions, this is specified by placing a call to the function `interactive' at the top level of the function body. See `interactive'. If optional second arg RECORD-FLAG is the symbol `lambda', the interactive calling arguments for FUNCTION are read and returned as a list, but the function is not called on them. If RECORD-FLAG is `t' then unconditionally put this command in the command-history. Otherwise, this is done only if an arg is read using the minibuffer. arguments: (FUNCTION &optional RECORD-FLAG) Fprefix-numeric-value Return numeric meaning of raw prefix argument ARG. A raw prefix argument is what you get from `(interactive "P")'. Its numeric meaning is what you would get from `(interactive "p")'. arguments: (RAW) Vprefix-arg The value of the prefix argument for the next editing command. It may be a number, or the symbol `-' for just a minus sign as arg, or a list whose car is a number for just one or more C-U's or nil if no argument has been specified. You cannot examine this variable to find the argument for this command since it has been set to nil by the time you can look. Instead, you should use the variable `current-prefix-arg', although normally commands can get this prefix argument with (interactive "P").Vcurrent-prefix-arg The value of the prefix argument for this editing command. It may be a number, or the symbol `-' for just a minus sign as arg, or a list whose car is a number for just one or more C-U's or nil if no argument has been specified. This is what `(interactive "P")' returns.Vcurrent-mouse-event The mouse-button event which invoked this command, or nil. This is what `(interactive "e")' returns.Vcommand-history List of recent commands that read arguments from terminal. Each command is represented as a form to evaluate.Vcommand-debug-status Debugging status of current interactive command. Bound each time `call-interactively' is called; may be set by the debugger as a reminder for itself.Fignore-defer-gettext If OBJ is of the form (defer-gettext "string"), return the string. The purpose of the defer-gettext symbol is to identify strings which are translated when they are referenced instead of when they are defined. arguments: (OBJ) Fgettext Look up STRING in the default message domain and return its translation. This function does nothing if I18N3 was not enabled when Emacs was compiled. arguments: (STRING) Fdgettext Look up STRING in the specified message domain and return its translation. This function does nothing if I18N3 was not enabled when Emacs was compiled. arguments: (DOMAIN STRING) Fbind-text-domain Associate a pathname with a message domain. Here's how the path to message files is constructed under SunOS 5.0: {pathname}/{LANG}/LC_MESSAGES/{domain}.mo This function does nothing if I18N3 was not enabled when Emacs was compiled. arguments: (DOMAIN PATHNAME) Fdomain Specify the domain used for translating messages in this source file. The domain declaration may only appear at top-level, and should preceed all function and variable definitions. The presence of this declaration in a compiled file effectively sets the domain of all functions and variables which are defined in that file. Bug: it has no effect on source (.el) files, only compiled (.elc) files. arguments: (DOMAIN-NAME) For Eval args until one of them yields non-nil, then return that value. The remaining args are not evalled at all. If all args return nil, return nil.Fand Eval args until one of them yields nil, then return nil. The remaining args are not evalled at all. If no arg yields nil, return the last arg's value.Fif (if COND THEN ELSE...): if COND yields non-nil, do THEN, else do ELSE... Returns the value of THEN or the value of the last of the ELSE's. THEN must be one expression, but ELSE... can be zero or more expressions. If COND yields nil, and there are no ELSE's, the value is nil.Fcond (cond CLAUSES...): try each clause until one succeeds. Each clause looks like (CONDITION BODY...). CONDITION is evaluated and, if the value is non-nil, this clause succeeds: then the expressions in BODY are evaluated and the last one's value is the value of the cond-form. If no clause succeeds, cond returns nil. If a clause has one element, as in (CONDITION), CONDITION's value if non-nil is returned from the cond-form.Fprogn (progn BODY...): eval BODY forms sequentially and return value of last one.Fprog1 (prog1 FIRST BODY...): eval FIRST and BODY sequentially; value from FIRST. The value of FIRST is saved during the evaluation of the remaining args, whose values are discarded.Fprog2 (prog1 X Y BODY...): eval X, Y and BODY sequentially; value from Y. The value of Y is saved during the evaluation of the remaining args, whose values are discarded.Flet* (let* VARLIST BODY...): bind variables according to VARLIST then eval BODY. The value of the last form in BODY is returned. Each element of VARLIST is a symbol (which is bound to nil) or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM). Each VALUEFORM can refer to the symbols already bound by this VARLIST.Flet (let VARLIST BODY...): bind variables according to VARLIST then eval BODY. The value of the last form in BODY is returned. Each element of VARLIST is a symbol (which is bound to nil) or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM). All the VALUEFORMs are evalled before any symbols are bound.Fwhile (while TEST BODY...): if TEST yields non-nil, eval BODY... and repeat. The order of execution is thus TEST, BODY, TEST, BODY and so on until TEST returns nil.Fsetq (setq SYM VAL SYM VAL ...): set each SYM to the value of its VAL. The SYMs are not evaluated. Thus (setq x y) sets x to the value of y. Each SYM is set before the next VAL is computed.Fquote Return the argument, without evaluating it. `(quote x)' yields `x'.Ffunction Like `quote', but preferred for objects which are functions. In byte compilation, `function' causes its argument to be compiled. `quote' cannot do that.Fdefun (defun NAME ARGLIST [DOCSTRING] BODY...): define NAME as a function. The definition is (lambda ARGLIST [DOCSTRING] BODY...). See also the function `interactive'.Fdefmacro (defmacro NAME ARGLIST [DOCSTRING] BODY...): define NAME as a macro. The definition is (macro lambda ARGLIST [DOCSTRING] BODY...). When the macro is called, as in (NAME ARGS...), the function (lambda ARGLIST BODY...) is applied to the list ARGS... as it appears in the expression, and the result should be a form to be evaluated instead of the original.Fdefvar (defvar SYMBOL INITVALUE DOCSTRING): define SYMBOL as a variable. You are not required to define a variable in order to use it, but the definition can supply documentation and an initial value in a way that tags can recognize. INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void. (However, when you evaluate a defvar interactively, it acts like a defconst: SYMBOL's value is always set regardless of whether it's currently void.) If SYMBOL is buffer-local, its default value is what is set; buffer-local values are not affected. INITVALUE and DOCSTRING are optional. If DOCSTRING starts with *, this variable is identified as a user option. This means that M-x set-variable and M-x edit-options recognize it. If INITVALUE is missing, SYMBOL's value is not set. In lisp-interaction-mode defvar is treated as defconst.Fdefconst (defconst SYMBOL INITVALUE DOCSTRING): define SYMBOL as a constant variable. The intent is that programs do not change this value, but users may. Always sets the value of SYMBOL to the result of evalling INITVALUE. If SYMBOL is buffer-local, its default value is what is set; buffer-local values are not affected. DOCSTRING is optional. If DOCSTRING starts with *, this variable is identified as a user option. This means that M-x set-variable and M-x edit-options recognize it. Note: do not use `defconst' for user options in libraries that are not normally loaded, since it is useful for users to be able to specify their own values for such variables before loading the library. Since `defconst' unconditionally assigns the variable, it would override the user's choice.Fuser-variable-p Return t if VARIABLE is intended to be set and modified by users. (The alternative is a variable used internally in a Lisp program.) Determined by whether the first character of the documentation for the variable is "*" arguments: (VARIABLE) Fmacroexpand Return result of expanding macros at top level of FORM. If FORM is not a macro call, it is returned unchanged. Otherwise, the macro is expanded and the expansion is considered in place of FORM. When a non-macro-call results, it is returned. The second optional arg ENVIRONMENT species an environment of macro definitions to shadow the loaded ones for use in file byte-compilation. arguments: (FORM &optional ENV) Fcatch (catch TAG BODY...): eval BODY allowing nonlocal exits using `throw'. TAG is evalled to get the tag to use. Then the BODY is executed. Within BODY, (throw TAG) with same tag exits BODY and exits this `catch'. If no throw happens, `catch' returns the value of the last BODY form. If a throw happens, it specifies the value to return from `catch'.Fthrow (throw TAG VALUE): throw to the catch for TAG and return VALUE from it. Both TAG and VALUE are evalled. arguments: (TAG VAL) Funwind-protect Do BODYFORM, protecting with UNWINDFORMS. Usage looks like (unwind-protect BODYFORM UNWINDFORMS...). If BODYFORM completes normally, its value is returned after executing the UNWINDFORMS. If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.Fcondition-case Regain control when an error is signalled. Usage looks like (condition-case VAR BODYFORM HANDLERS...). executes BODYFORM and returns its value if no error happens. Each element of HANDLERS looks like (CONDITION-NAME BODY...) where the BODY is made of Lisp expressions. A handler is applicable to an error if CONDITION-NAME is one of the error's condition names. If an error happens, the first applicable handler is run. As a special case, a CONDITION-NAME of t matches all errors, even those without the `error' condition name on them (e.g. `quit'). The car of a handler may be a list of condition names instead of a single condition name. When a handler handles an error, control returns to the condition-case and the handler BODY... is executed with VAR bound to (SIGNALED-CONDITIONS . SIGNAL-DATA). VAR may be nil; then you do not get access to the signal information. The value of the last BODY form is returned from the condition-case. See also the function `signal' for more info. Note that at the time the condition handler is invoked, the Lisp stack and the current catches, condition-cases, and bindings have all been popped back to the state they were in just before the call to `condition-case'. This means that resignalling the error from within the handler will not result in an infinite loop. If you want to establish an error handler that is called with the Lisp stack, bindings, etc. as they were when `signal' was called, rather than when the handler was set, use `call-with-condition-handler'.Fcall-with-condition-handler Regain control when an error is signalled, without popping the stack. Usage looks like (call-with-condition-handler HANDLER FUNCTION &rest ARGS). This function is similar to `condition-case', but the handler is invoked with the same environment (Lisp stack, bindings, catches, condition-cases) that was current when `signal' was called, rather than when the handler was established. HANDLER should be a function of one argument, which is a cons of the args (SIG . DATA) that were passed to `signal'. It is invoked whenever `signal' is called (this differs from `condition-case', which allows you to specify which errors are trapped). If the handler function returns, `signal' continues as if the handler were never invoked. (It continues to look for handlers established earlier than this one, and invokes the standard error-handler if none is found.)Fsignal Signal an error. Args are SIGNAL-NAME, and associated DATA. A signal name is a symbol with an `error-conditions' property that is a list of condition names. A handler for any of those names will get to handle this signal. The symbol `error' should normally be one of them. DATA should be a list. Its elements are printed as part of the error message. If the signal is handled, DATA is made available to the handler. See also the function `condition-case'. arguments: (SIG DATA) Fcommandp T if FUNCTION makes provisions for interactive calling. This means it contains a description for how to read arguments to give it. The value is nil for an invalid function or a symbol with no function definition. Interactively callable functions include strings and vectors (treated as keyboard macros), lambda-expressions that contain a top-level call to `interactive', autoload definitions made by `autoload' with non-nil fourth argument, and some of the built-in functions of Lisp. Also, a symbol satisfies `commandp' if its function definition does so. arguments: (FUNCTION) Fcommand-execute Execute CMD as an editor command. CMD must be a symbol that satisfies the `commandp' predicate. Optional second arg RECORD-FLAG is as in 'call-interactively'. arguments: (CMD &optional RECORD) Finteractive-p Return t if function in which this appears was called interactively. This means that the function was called with call-interactively (which includes being called as the binding of a key) and input is currently coming from the keyboard (not in keyboard macro). arguments: () Fautoload Define FUNCTION to autoload from FILE. FUNCTION is a symbol; FILE is a file name string to pass to `load'. Third arg DOCSTRING is documentation for the function. Fourth arg INTERACTIVE if non-nil says function can be called interactively. Fifth arg TYPE indicates the type of the object: nil or omitted says FUNCTION is a function, `keymap' says FUNCTION is really a keymap, and `macro' or t says FUNCTION is really a macro. Third through fifth args give info about the real definition. They default to nil. If FUNCTION is already defined other than as an autoload, this does nothing and returns nil. arguments: (FUNCTION FILE &optional DOCSTRING INTERACTIVE TYPE) Feval Evaluate FORM and return its value. arguments: (FORM) Ffuncall Call first argument as a function, passing remaining arguments to it. Thus, (funcall 'cons 'x 'y) returns (x . y).Fapply Call FUNCTION with our remaining args, using our last arg as list of args. Thus, (apply '+ 1 2 '(3 4)) returns 10.Fbacktrace-debug Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG. The debugger is entered when that frame exits, if the flag is non-nil. arguments: (LEVEL FLAG) Fbacktrace Print a trace of Lisp function calls currently active. Option arg STREAM specifies the output stream to send the backtrace to, and defaults to the value of `standard-output'. Optional second arg DETAILED means show places where currently active variable bindings, catches, condition-cases, and unwind-protects were made as well as function calls. arguments: (&optional STREAM DETAILED) Fbacktrace-frame Return the function and arguments N frames up from current execution point. If that frame has not evaluated the arguments yet (or is a special form), the value is (nil FUNCTION ARG-FORMS...). If that frame has evaluated its arguments and called its function already, the value is (t FUNCTION ARG-VALUES...). A &rest arg is represented as the tail of the list ARG-VALUES. FUNCTION is whatever was supplied as car of evaluated list, or a lambda expression for macro calls. If N is more than the number of frames, the value is nil. arguments: (NFRAMES) Vmax-specpdl-size Limit on number of Lisp variable bindings & unwind-protects before error.Vmax-lisp-eval-depth Limit on depth in `eval', `apply' and `funcall' before error. This limit is to catch infinite recursions for you before they cause actual stack overflow in C, which would be fatal for Emacs. You can safely make it considerably larger than its default value, if that proves inconveniently small.Vquit-flag Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil. Typing C-G sets `quit-flag' non-nil, regardless of `inhibit-quit'.Vinhibit-quit Non-nil inhibits C-g quitting from happening immediately. Note that `quit-flag' will still be set by typing C-g, so a quit will be signalled as soon as `inhibit-quit' is nil. To prevent this happening, set `quit-flag' to nil before making `inhibit-quit' nil. The value of `inhibit-quit' is ignored if a critical quit is requested by typing control-shift-G in an X frame.Vstack-trace-on-error *Non-nil means automatically display a backtrace buffer after any error that is not handled by a `condition-case'. If the value is a list, an error only means to display a backtrace if one of its condition symbols appears in the list. See also variable `stack-trace-on-signal'.Vstack-trace-on-signal *Non-nil means automatically display a backtrace buffer after any error that is signalled, whether or not it is handled by a `condition-case'. If the value is a list, an error only means to display a backtrace if one of its condition symbols appears in the list. See also variable `stack-trace-on-error'.Vdebug-on-error *Non-nil means enter debugger if an unhandled error is signalled. The debugger will not be entered if the error is handled by a `condition-case'. If the value is a list, an error only means to enter the debugger if one of its condition symbols appears in the list. See also variables `debug-on-quit' and `debug-on-signal'.Vdebug-on-signal *Non-nil means enter debugger if an error is signalled. The debugger will be entered whether or not the error is handled by a `condition-case'. If the value is a list, an error only means to enter the debugger if one of its condition symbols appears in the list. See also variable `debug-on-quit'.Vdebug-on-quit *Non-nil means enter debugger if quit is signalled (C-G, for example). Does not apply if quit is handled by a `condition-case'. Entering the debugger can also be achieved at any time (for X11 devices) by typing control-shift-G to signal a critical quit.Vdebug-on-next-call Non-nil means enter debugger before next `eval', `apply' or `funcall'.Vdebugger Function to call to invoke debugger. If due to frame exit, args are `exit' and the value being returned; this function's value will be returned instead of that. If due to error, args are `error' and a list of the args to `signal'. If due to `apply' or `funcall' entry, one arg, `lambda'. If due to `eval' entry, one arg, t.Vrun-hooks Set to the function `run-hooks', if that function has been defined. Otherwise, nil (in a bare Emacs without preloaded Lisp code).Facos Return the inverse cosine of ARG. arguments: (ARG) Fasin Return the inverse sine of ARG. arguments: (ARG) Fatan Return the inverse tangent of ARG. arguments: (ARG1 &optional ARG2) Fcos Return the cosine of ARG. arguments: (ARG) Fsin Return the sine of ARG. arguments: (ARG) Ftan Return the tangent of ARG. arguments: (ARG) Fbessel-j0 Return the bessel function j0 of ARG. arguments: (ARG) Fbessel-j1 Return the bessel function j1 of ARG. arguments: (ARG) Fbessel-jn Return the order N bessel function output jn of ARG. The first arg (the order) is truncated to an integer. arguments: (ARG1 ARG2) Fbessel-y0 Return the bessel function y0 of ARG. arguments: (ARG) Fbessel-y1 Return the bessel function y1 of ARG. arguments: (ARG) Fbessel-yn Return the order N bessel function output yn of ARG. The first arg (the order) is truncated to an integer. arguments: (ARG1 ARG2) Ferf Return the mathematical error function of ARG. arguments: (ARG) Ferfc Return the complementary error function of ARG. arguments: (ARG) Flog-gamma Return the log gamma of ARG. arguments: (ARG) Fexp Return the exponential base e of ARG. arguments: (ARG) Fexpt Return the exponential X ** Y. arguments: (ARG1 ARG2) Flog Return the natural logarithm of ARG. If second optional argument BASE is given, return log ARG using that base. arguments: (ARG &optional BASE) Flog10 Return the logarithm base 10 of ARG. arguments: (ARG) Fsqrt Return the square root of ARG. arguments: (ARG) Fcube-root Return the cube root of ARG. arguments: (ARG) Facosh Return the inverse hyperbolic cosine of ARG. arguments: (ARG) Fasinh Return the inverse hyperbolic sine of ARG. arguments: (ARG) Fatanh Return the inverse hyperbolic tangent of ARG. arguments: (ARG) Fcosh Return the hyperbolic cosine of ARG. arguments: (ARG) Fsinh Return the hyperbolic sine of ARG. arguments: (ARG) Ftanh Return the hyperbolic tangent of ARG. arguments: (ARG) Fabs Return the absolute value of ARG. arguments: (ARG) Ffloat Return the floating point number equal to ARG. arguments: (ARG) Flogb Return largest integer <= the base 2 log of the magnitude of ARG. This is the same as the exponent of a float. arguments: (ARG) Fceiling Return the smallest integer no less than ARG. (Round toward +inf.) arguments: (ARG) Ffloor Return the largest integer no greater than ARG. (Round towards -inf.) With optional DIVISOR, return the largest integer no greater than ARG/DIVISOR. arguments: (ARG &optional DIVISOR) Fround Return the nearest integer to ARG. arguments: (ARG) Ftruncate Truncate a floating point number to an integer. Rounds the value toward zero. arguments: (ARG) Ffceiling Return the smallest integer no less than ARG, as a float. (Round toward +inf.) arguments: (ARG) Fffloor Return the largest integer no greater than ARG, as a float. (Round towards -inf.) arguments: (ARG) Ffround Return the nearest integer to ARG, as a float. arguments: (ARG) Fftruncate Truncate a floating point number to an integral float value. Rounds the value toward zero. arguments: (ARG) Fidentity Return the argument unchanged. arguments: (ARG) Frandom Return a pseudo-random number. On most systems all integers representable in Lisp are equally likely. A lisp integer is a few bits smaller than a C `long'; on most systems, this means 28 bits.) With argument N, return random number in interval [0,N). With argument t, set the random number seed from the current time and pid. arguments: (&optional LIMIT) Flength Return the length of vector, list or string SEQUENCE. arguments: (OBJ) Fstring-equal T if two strings have identical contents. Case is significant. Symbols are also allowed; their print names are used instead. arguments: (S1 S2) Fstring-lessp T if first arg string is less than second in lexicographic order. If I18N2 support was compiled in, ordering is determined by the locale. Case is significant for the default C locale. Symbols are also allowed; their print names are used instead. arguments: (S1 S2) Fstring-modified-tick Return STRING's tick counter, incremented for each change to the string. Each string has a tick counter which is incremented each time the contents of the string are changed (e.g. with `aset'). It wraps around occasionally. arguments: (STRING) Fappend Concatenate all the arguments and make the result a list. The result is a list whose elements are the elements of all the arguments. Each argument may be a list, vector or string. The last argument is not copied, just used as the tail of the new list.Fconcat Concatenate all the arguments and make the result a string. The result is a string whose elements are the elements of all the arguments. Each argument may be a string, a character (integer), a list of characters, or a vector of numbers.Fvconcat Concatenate all the arguments and make the result a vector. The result is a vector whose elements are the elements of all the arguments. Each argument may be a list, vector or string.Fcopy-sequence Return a copy of a list, vector or string. The elements of a list or vector are not copied; they are shared with the original. arguments: (ARG) Fcopy-alist Return a copy of ALIST. This is an alist which represents the same mapping from objects to objects, but does not share the alist structure with ALIST. The objects mapped (cars and cdrs of elements of the alist) are shared, however. Elements of ALIST that are not conses are also shared. arguments: (ALIST) Fcopy-tree Return a copy of a list and substructures. The argument is copied, and any lists contained within it are copied recursively. Circularities and shared substructures are not preserved. Second arg VECP causes vectors to be copied, too. Strings are not copied. arguments: (ARG &optional VECP) Fsubstring Return a substring of STRING, starting at index FROM and ending before TO. TO may be nil or omitted; then the substring runs to the end of STRING. If FROM or TO is negative, it counts from the end. Relevant parts of the string-extent-data are copied in the new string. arguments: (STRING FROM &optional TO) Fnthcdr Take cdr N times on LIST, returns the result. arguments: (N LIST) Fnth Return the Nth element of LIST. N counts from zero. If LIST is not that long, nil is returned. arguments: (N LIST) Felt Return element of SEQUENCE at index N. arguments: (SEQ N) Fmember Return non-nil if ELT is an element of LIST. Comparison done with `equal'. The value is actually the tail of LIST whose car is ELT. arguments: (ELT LIST) Fmemq Return non-nil if ELT is an element of LIST. Comparison done with EQ. The value is actually the tail of LIST whose car is ELT. arguments: (ELT LIST) Fassoc Return non-nil if KEY is `equal' to the car of an element of LIST. The value is actually the element of LIST whose car is KEY. arguments: (KEY LIST) Fassq Return non-nil if KEY is `eq' to the car of an element of LIST. The value is actually the element of LIST whose car is KEY. Elements of LIST that are not conses are ignored. arguments: (KEY LIST) Frassoc Return non-nil if KEY is `equal' to the cdr of an element of LIST. The value is actually the element of LIST whose cdr is KEY. arguments: (KEY LIST) Frassq Return non-nil if KEY is `eq' to the cdr of an element of LIST. The value is actually the element of LIST whose cdr is KEY. arguments: (KEY LIST) Fdelete Delete by side effect any occurrences of ELT as a member of LIST. The modified LIST is returned. Comparison is done with `equal'. If the first member of LIST is ELT, there is no way to remove it by side effect; therefore, write `(setq foo (delete element foo))' to be sure of changing the value of `foo'. arguments: (ELT LIST) Fdelq Delete by side effect any occurrences of ELT as a member of LIST. The modified LIST is returned. Comparison is done with `eq'. If the first member of LIST is ELT, there is no way to remove it by side effect; therefore, write `(setq foo (delq element foo))' to be sure of changing the value of `foo'. arguments: (ELT LIST) Fremassoc Delete by side effect any elements of LIST whose car is `equal' to KEY. The modified LIST is returned. If the first member of LIST has a car that is `equal' to KEY, there is no way to remove it by side effect; therefore, write `(setq foo (remassoc key foo))' to be sure of changing the value of `foo'. arguments: (KEY LIST) Fremassq Delete by side effect any elements of LIST whose car is `eq' to KEY. The modified LIST is returned. If the first member of LIST has a car that is `eq' to KEY, there is no way to remove it by side effect; therefore, write `(setq foo (remassq key foo))' to be sure of changing the value of `foo'. arguments: (KEY LIST) Fremrassoc Delete by side effect any elements of LIST whose cdr is `equal' to KEY. The modified LIST is returned. If the first member of LIST has a car that is `equal' to KEY, there is no way to remove it by side effect; therefore, write `(setq foo (remrassoc key foo))' to be sure of changing the value of `foo'. arguments: (KEY LIST) Fremrassq Delete by side effect any elements of LIST whose cdr is `eq' to KEY. The modified LIST is returned. If the first member of LIST has a car that is `eq' to KEY, there is no way to remove it by side effect; therefore, write `(setq foo (remrassq key foo))' to be sure of changing the value of `foo'. arguments: (KEY LIST) Fnreverse Reverse LIST by modifying cdr pointers. Returns the beginning of the reversed list. arguments: (LIST) Freverse Reverse LIST, copying. Returns the beginning of the reversed list. See also the function `nreverse', which is used more often. arguments: (LIST) Fsort Sort LIST, stably, comparing elements using PREDICATE. Returns the sorted list. LIST is modified by side effects. PREDICATE is called with two elements of LIST, and should return T if the first element is "less" than the second. arguments: (LIST PRED) Fplists-eq Return non-nil if property lists A and B are `eq'. A property list is an alternating list of keywords and values, where a nil value is equivalent to the property not existing. This function does order-insensitive comparisons of the property lists: For example, the property lists '(a 1 b 2 c nil) and '(b 2 a 1) are equal. Comparison between values is done using `eq'. See also `plists-equal'. arguments: (A B) Fplists-equal Return non-nil if property lists A and B are `equal'. A property list is an alternating list of keywords and values, where a nil value is equivalent to the property not existing. This function does order-insensitive comparisons of the property lists: For example, the property lists '(a 1 b 2 c nil) and '(b 2 a 1) are equal. Comparison between values is done using `equal'. See also `plists-eq'. arguments: (A B) Fgetf Search PROPLIST for property PROPNAME; return its value or DEFAULT. PROPLIST is a list of the sort returned by `symbol-plist'. arguments: (PLIST PROP &optional DEFAULT) Fget Return the value of OBJECT's PROPNAME property. This is the last VALUE stored with `(put OBJECT PROPNAME VALUE)'. If there is no such property, return optional third arg DEFAULT (which defaults to `nil'). OBJECT can be a symbol, face, extent, or string. See also `put', `remprop', and `object-props'. arguments: (OBJECT PROPNAME &optional DEFAULT) Fput Store OBJECT's PROPNAME property with value VALUE. It can be retrieved with `(get OBJECT PROPNAME)'. OBJECT can be a symbol, face, extent, or string. For a string, the following symbols have predefined meanings: dup-list List of string's extent replicas. For the predefined properties for extents, see `set-extent-property'. For the predefined properties for faces, see `set-face-property'. See also `get', `remprop', and `object-props'. arguments: (OBJECT PROPNAME VALUE) Fremprop Remove from OBJECT's property list the property PROPNAME and its value. OBJECT can be a symbol, face, extent, or string. Returns non-nil if the property list was actually changed (i.e. if PROPNAME was present in the property list). See also `get', `put', and `object-props'. arguments: (OBJECT PROPNAME) Fobject-props Return a property list of OBJECT's props. This is a copy of OBJECT's property list, not the actual property list stored in the object; therefore, you cannot change a property on OBJECT by modifying this list. Use `put' for that. Note that for a symbol, this function is not the same as `symbol-plist'; that function returns the actual property list, whereas `object-props' returns a copy of the property list. arguments: (OBJECT) Fequal T if two Lisp objects have similar structure and contents. They must have the same data type. Conses are compared by comparing the cars and the cdrs. Vectors and strings are compared element by element. Numbers are compared by value. Symbols must match exactly. arguments: (O1 O2) Ffillarray Store each element of ARRAY with ITEM. ARRAY is a vector or string. arguments: (ARRAY ITEM) Fnconc Concatenate any number of lists by altering them. Only the last argument is not altered, and need not be a list.Fmapconcat Apply FN to each element of SEQ, and concat the results as strings. In between each pair of results, stick in SEP. Thus, " " as SEP results in spaces between the values returned by FN. arguments: (FN SEQ SEP) Fmapcar Apply FUNCTION to each element of SEQUENCE, and make a list of the results. The result is a list just as long as SEQUENCE. SEQUENCE may be a list, a vector or a string. arguments: (FN SEQ) Fload-average Return list of 1 minute, 5 minute and 15 minute load averages. Each of the three load averages is multiplied by 100, then converted to integer. If the 5-minute or 15-minute load averages are not available, return a shortened list, containing only those averages which are available. On most systems, this won't work unless the emacs executable is installed as setgid kmem (assuming that /dev/kmem is in the group kmem). arguments: () Ffeaturep Return t if FEATURE is present in this Emacs. Use this to conditionalize execution of lisp code based on the presence or absence of emacs or environment extensions. Use `provide' to declare that a feature is available. This function looks at the value of the variable `features'. arguments: (FEATURE) Fprovide Announce that FEATURE is a feature of the current Emacs. arguments: (FEATURE) Frequire If feature FEATURE is not loaded, load it from FILENAME. If FEATURE is not a member of the list `features', then the feature is not loaded; so load the file FILENAME. If FILENAME is omitted, the printname of FEATURE is used as the file name. arguments: (FEATURE &optional FILE-NAME) Vfeatures A list of symbols which are the features of the executing emacs. Used by `featurep' and `require', and altered by `provide'.Fwrite-char Output character CH to stream STREAM. STREAM defaults to the value of `standard-output' (which see). arguments: (CH &optional STREAM) Fwith-output-to-temp-buffer Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer. The buffer is cleared out initially, and marked as unmodified when done. All output done by BODY is inserted in that buffer by default. The buffer is displayed in another window, but not selected. The value of the last form in BODY is returned. If BODY does not finish normally, the buffer BUFNAME is not displayed. If variable `temp-buffer-show-function' is non-nil, call it at the end to get the buffer displayed. It gets one argument, the buffer to display.Fterpri Output a newline to STREAM. If STREAM is omitted or nil, the value of `standard-output' is used. arguments: (&optional STREAM) Fprin1 Output the printed representation of OBJECT, any Lisp object. Quoting characters are printed when needed to make output that `read' can handle, whenever this is possible. Output stream is STREAM, or value of `standard-output' (which see). arguments: (OBJECT &optional STREAM) Fprin1-to-string Return a string containing the printed representation of OBJECT, any Lisp object. Quoting characters are used when needed to make output that `read' can handle, whenever this is possible, unless the optional second argument NOESCAPE is non-nil. arguments: (OBJECT &optional NOESCAPE) Fprinc Output the printed representation of OBJECT, any Lisp object. No quoting characters are used; no delimiters are printed around the contents of strings. Output stream is STREAM, or value of standard-output (which see). arguments: (OBJ &optional STREAM) Fprint Output the printed representation of OBJECT, with newlines around it. Quoting characters are printed when needed to make output that `read' can handle, whenever this is possible. Output stream is STREAM, or value of `standard-output' (which see). arguments: (OBJ &optional STREAM) Falternate-debugging-output Append CHARACTER to the array `alternate_do_string'. This can be used in place of `external-debugging-output' as a function to be passed to `print'. Before calling `print', set `alternate_do_pointer' to 0. arguments: (CHARACTER) Fexternal-debugging-output Write CHAR-OR-STRING to stderr or stdout. If optional arg STDOUT-P is non-nil, write to stdout; otherwise, write to stderr. You can use this function to write directly to the terminal. This function can be used as the STREAM argument of Fprint() or the like. If you have opened a termscript file (using `open-termscript'), then the output also will be logged to this file. arguments: (CHAR-OR-STRING &optional STDOUT-P) Fopen-termscript Start writing all terminal output to FILE as well as the terminal. FILE = nil means just close any termscript file currently open. arguments: (FILE) Vstandard-output Output stream `print' uses by default for outputting a character. This may be any function of one argument. It may also be a buffer (output is inserted before point) or a marker (output is inserted and the marker is advanced) or the symbol t (output appears in the minibuffer line).Vfloat-output-format The format descriptor string that lisp uses to print floats. This is a %-spec like those accepted by `printf' in C, but with some restrictions. It must start with the two characters `%.'. After that comes an integer precision specification, and then a letter which controls the format. The letters allowed are `e', `f' and `g'. Use `e' for exponential notation "DIG.DIGITSeEXPT" Use `f' for decimal point notation "DIGITS.DIGITS". Use `g' to choose the shorter of those two formats for the number at hand. The precision in any of these cases is the number of digits following the decimal point. With `f', a precision of 0 means to omit the decimal point. 0 is not allowed with `f' or `g'. A value of nil means to use `%.16g'. Regardless of the value of `float-output-format', a floating point number will never be printed in such a way that it is ambiguous with an integer; that is, a floating-point number will always be printed with a decimal point and/or an exponent, even if the digits following the decimal point are all zero. This is to preserve read-equivalence.Vprint-length Maximum length of list or vector to print before abbreviating. A value of nil means no limit.Vprint-string-length Maximum length of string to print before abbreviating. A value of nil means no limit.Vprint-level Maximum depth of list nesting to print before abbreviating. A value of nil means no limit.Vprint-escape-newlines Non-nil means print newlines in strings as backslash-n.Vprint-readably If non-nil, then all objects will be printed in a readable form. If an object has no readable representation, then an error is signalled. When print-readably is true, compiled-function objects will be written in #[...] form instead of in #<byte-code [...]> form, and two-element lists of the form (quote object) will be written as the equivalent 'object. Do not SET this variable; bind it instead.Vprint-gensym If non-nil, then uninterned symbols will be printed specially. Uninterned symbols are those which are not present in `obarray', that is, those which were made with `make-symbol' or by calling `intern' with a second argument. When print-gensym is true, such symbols will be preceeded by "#:", which causes the reader to create a new symbol instead of interning and returning an existing one. Beware: the #: syntax creates a new symbol each time it is seen, so if you print an object which contains two pointers to the same uninterned symbol, `read' will not duplicate that structure. Also, since emacs has no real notion of packages, there is no way for the printer to distinguish between symbols interned in no obarray, and symbols interned in an alternate obarray.Vprint-message-label Label for minibuffer messages created with `print'. This should generally be bound with `let' rather than set. (See `display-message'.)Fload-internal Execute a file of Lisp code named FILE. First try LIBRARY with `.elc' appended, then try with `.el', then try LIBRARY unmodified. This function searches the directories in `load-path'. If optional second arg NOERROR is non-nil, report no error if LIBRARY doesn't exist. Print messages at start and end of loading unless optional third arg NOMESSAGE is non-nil (ignored in -batch mode). If optional fourth arg NOSUFFIX is non-nil, don't try adding suffixes `.elc' or `.el' to the specified name LIBRARY. Return t if file exists. arguments: (LIBRARY &optional NO-ERROR NOMESSAGE NOSUFFIX) Flocate-file Search for FILENAME through PATH-LIST, expanded by one of the optional SUFFIXES (string of suffixes separated by ":"s), checking for access MODE (0|1|2|4 = exists|executable|writeable|readable), default readable. `locate-file' keeps hash tables of the directories it searches through, in order to speed things up. It tries valiantly to not get confused in the face of a changing and unpredictable environment, but can occasionally get tripped up. In this case, you will have to call `locate-file-clear-hashing' to get it back on track. See that function for details. arguments: (FILE PATH &optional SUFF MODE) Flocate-file-clear-hashing Clear the hash records for the specified list of directories. `locate-file' uses a hashing scheme to speed lookup, and will correctly track the following environmental changes: -- changes of any sort to the list of directories to be searched. -- addition and deletion of non-shadowing files (see below) from the directories in the list. -- byte-compilation of a .el file into a .elc file. `locate-file' will primarily get confused if you add a file that shadows (i.e. has the same name as) another file further down in the directory list. In this case, you must call `locate-file-clear-hashing'. arguments: (PATH) Feval-buffer Execute BUFFER as Lisp code. Programs can pass argument PRINTFLAG which controls printing of output: nil means discard it; anything else is stream for print. arguments: (BUFNAME &optional PRINTFLAG) Feval-region Execute the region as Lisp code. When called from programs, expects two arguments, giving starting and ending indices in the current buffer of the text to be executed. Programs can pass third argument PRINTFLAG which controls output: nil means discard it; anything else is stream for printing it. If there is no error, point does not move. If there is an error, point remains at the end of the last character read from the buffer. Note: Before evaling the region, this function narrows the buffer to it. If the code being eval'd should happen to trigger a redisplay you may see some text temporarily disappear because of this. arguments: (B E &optional PRINTFLAG) Fread Read one Lisp expression as text from STREAM, return as Lisp object. If STREAM is nil, use the value of `standard-input' (which see). STREAM or the value of `standard-input' may be: a buffer (read from point and advance it) a marker (read from where it points and advance it) a function (call it with no arguments for each character, call it with a char as argument to push a char back) a string (takes text from string, starting at the beginning) t (read text line using minibuffer and use it). arguments: (&optional STREAM) Fread-from-string Read one Lisp expression which is represented as text by STRING. Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX). START and END optionally delimit a substring of STRING from which to read; they default to 0 and (length STRING) respectively. arguments: (STRING &optional START END) Vvalues List of values of all expressions which were read, evaluated and printed. Order is reverse chronological.Vstandard-input Stream for read to get input from. See documentation of `read' for possible values.Vload-path *List of directories to search for files to load. Each element is a string (directory name) or nil (try default directory). Note that the elements of this list *may not* begin with "~", so you must call `expand-file-name' on them before adding them to this list. Initialized based on EMACSLOADPATH environment variable, if any, otherwise to default specified in by file `paths.h' when Emacs was built. If there were no paths specified in `paths.h', then emacs chooses a default value for this variable by looking around in the file-system near the directory in which the emacs executable resides.Vload-in-progress Non-nil iff inside of `load'.Vafter-load-alist An alist of expressions to be evalled when particular files are loaded. Each element looks like (FILENAME FORMS...). When `load' is run and the file-name argument is FILENAME, the FORMS in the corresponding element are executed at the end of loading. FILENAME must match exactly! Normally FILENAME is the name of a library, with no directory specified, since that is how `load' is normally called. An error in FORMS does not undo the load, but does prevent execution of the rest of the FORMS.Vload-warn-when-source-newer *Whether `load' should check whether the source is newer than the binary; If this variable is true, then when a `.elc' file is being loaded and the corresponding `.el' is newer, a warning message will be printed.Vload-warn-when-source-only *Whether `load' should warn when loading a .el file instead of an .elc. If this variable is true, then when load is called with a filename without an extension, and the .elc version doesn't exist but the .el version does, then a message will be printed. If an explicit extension is passed to load, no warning will be printed.Vload-ignore-elc-files *Whether `load' should ignore `.elc' files when a suffix is not given. This is normally used only to bootstrap the .elc files when building Emacs.Vload-history Alist mapping source file names to symbols and features. Each alist element is a list that starts with a file name, except for one element (optional) that starts with nil and describes definitions evaluated from buffers not visiting files. The remaining elements of each list are symbols defined as functions or variables, and cons cells `(provide . FEATURE)' and `(require . FEATURE)'.Vcurrent-load-list Used for internal purposes by `load'.Vfail-on-bucky-bit-character-escapes Whether `read' should signal an error when it encounters unsupported character escape syntaxes or just read them incorrectly.Fintern Return the canonical symbol whose name is STRING. If there is none, one is created by this function and returned. A second optional argument specifies the obarray to use; it defaults to the value of `obarray'. arguments: (STR &optional OBARRAY) Fintern-soft Return the canonical symbol whose name is STRING, or nil if none exists. A second optional argument specifies the obarray to use; it defaults to the value of `obarray'. arguments: (STR &optional OBARRAY) Fmapatoms Call FUNCTION on every symbol in OBARRAY. OBARRAY defaults to the value of `obarray'. arguments: (FUNCTION &optional OBARRAY) Fapropos-internal Show all symbols whose names contain match for REGEXP. If optional 2nd arg PRED is non-nil, (funcall PRED SYM) is done for each symbol and a symbol is mentioned only if that returns non-nil. Return list of symbols found. arguments: (STRING &optional PRED) Fboundp T if SYMBOL's value is not void. arguments: (SYM) Fglobally-boundp T if SYMBOL has a global (non-bound) value. This is for the byte-compiler; you really shouldn't be using this. arguments: (SYM) Ffboundp T if SYMBOL's function definition is not void. arguments: (SYM) Fmakunbound Make SYMBOL's value be void. arguments: (SYM) Ffmakunbound Make SYMBOL's function definition be void. arguments: (SYM) Fsymbol-function Return SYMBOL's function definition. Error if that is void. arguments: (SYMBOL) Fsymbol-plist Return SYMBOL's property list. arguments: (SYM) Fsymbol-name Return SYMBOL's name, a string. arguments: (SYM) Ffset Set SYMBOL's function definition to NEWVAL, and return NEWVAL. arguments: (SYM NEWDEF) Fdefine-function Set SYMBOL's function definition to NEWVAL, and return NEWVAL. Associates the function with the current load file, if any. arguments: (SYM NEWDEF) Fsetplist Set SYMBOL's property list to NEWVAL, and return NEWVAL. arguments: (SYM NEWPLIST) Fsymbol-value Return SYMBOL's value. Error if that is void. arguments: (SYM) Fset Set SYMBOL's value to NEWVAL, and return NEWVAL. arguments: (SYM NEWVAL) Fdefault-boundp Return T if SYMBOL has a non-void default value. This is the value that is seen in buffers that do not have their own values for this variable. arguments: (SYM) Fdefault-value Return SYMBOL's default value. This is the value that is seen in buffers that do not have their own values for this variable. The default value is meaningful for variables with local bindings in certain buffers. arguments: (SYM) Fset-default Set SYMBOL's default value to VAL. SYMBOL and VAL are evaluated. The default value is seen in buffers that do not have their own values for this variable. arguments: (SYM VALUE) Fsetq-default Set the default value of variable VAR to VALUE. VAR, the variable name, is literal (not evaluated); VALUE is an expression and it is evaluated. The default value of a variable is seen in buffers that do not have their own values for the variable. More generally, you can use multiple variables and values, as in (setq-default SYM VALUE SYM VALUE...) This sets each SYM's default value to the corresponding VALUE. The VALUE for the Nth SYM can refer to the new default values of previous SYMs.Fmake-variable-buffer-local Make VARIABLE have a separate value for each buffer. At any time, the value for the current buffer is in effect. There is also a default value which is seen in any buffer which has not yet set its own value. Using `set' or `setq' to set the variable causes it to have a separate value for the current buffer if it was previously using the default value. The function `default-value' gets the default value and `set-default' sets it. arguments: (VARIABLE) Fmake-local-variable Make VARIABLE have a separate value in the current buffer. Other buffers will continue to share a common default value. (The buffer-local value of VARIABLE starts out as the same value VARIABLE previously had. If VARIABLE was void, it remains void.) See also `make-variable-buffer-local'. If the variable is already arranged to become local when set, this function causes a local value to exist for this buffer, just as if the variable were set. arguments: (VARIABLE) Fkill-local-variable Make VARIABLE no longer have a separate value in the current buffer. From now on the default value will apply in this buffer. arguments: (VARIABLE) Fsymbol-value-in-buffer Return the value of SYMBOL in BUFFER, or UNBOUND-VALUE if it is unbound. arguments: (SYMBOL BUFFER UNBOUND-VALUE) Flocal-variable-p Return t if SYMBOL's value is local to BUFFER. If optional third arg AFTER-SET is true, return t if SYMBOL would be buffer-local after it is set, regardless of whether it is so presently. arguments: (SYMBOL BUFFER &optional AFTER-SET) Fdefvaralias Define a variable as an alias for another variable. Thenceforth, any operations performed on VARIABLE will actually be performed on ALIAS. Both VARIABLE and ALIAS should be symbols. If ALIAS is nil, remove any aliases for VARIABLE. ALIAS can itself be aliased, and the chain of variable aliases will be followed appropriately. If VARIABLE already has a value, this value will be shadowed until the alias is removed, at which point it will be restored. Currently VARIABLE cannot be a built-in variable, a variable that has a buffer-local value in any buffer, or the symbols nil or t. arguments: (VARIABLE ALIAS) Fvariable-alias If VARIABLE is aliased to another variable, return that variable. VARIABLE should be a symbol. If VARIABLE is not aliased, return nil. Variable aliases are created with `defvaralias'. See also `indirect-variable'. arguments: (VARIABLE) Findirect-variable Return the variable at the end of OBJECT's variable-alias chain. If OBJECT is a symbol, follow all variable aliases and return the final (non-aliased) symbol. Variable aliases are created with the function `defvaralias'. If OBJECT is not a symbol, just return it. Signal a cyclic-variable-indirection error if there is a loop in the variable chain of symbols. arguments: (OBJECT) Vobarray Symbol table for use by `intern' and `read'. It is a vector whose length ought to be prime for best results. The vector's contents don't make sense if examined from Lisp programs; to find all the symbols in an obarray, use `mapatoms'.Fexpand-abbrev Expand the abbrev before point, if there is an abbrev there. Effective when explicitly called even when `abbrev-mode' is nil. Returns t if expansion took place. arguments: () Vglobal-abbrev-table The abbrev table whose abbrevs affect all buffers. Each buffer may also have a local abbrev table. If it does, the local table overrides the global one for any particular abbrev defined in both.Vlast-abbrev The abbrev-symbol of the last abbrev expanded. See the function `abbrev-symbol'.Vlast-abbrev-text The exact text of the last abbrev expanded. nil if the abbrev has already been unexpanded.Vlast-abbrev-location The location of the start of the last abbrev expanded.Vabbrev-start-location Buffer position for `expand-abbrev' to use as the start of the abbrev. nil means use the word before point as the abbrev. Calling `expand-abbrev' sets this to nil.Vabbrev-start-location-buffer Buffer that `abbrev-start-location' has been set for. Trying to expand an abbrev in any other buffer clears `abbrev-start-location'.Vabbrev-all-caps *Set non-nil means expand multi-word abbrevs all caps if abbrev was so.Vpre-abbrev-expand-hook Function or functions to be called before abbrev expansion is done. This is the first thing that `expand-abbrev' does, and so this may change the current abbrev table before abbrev lookup happens.Fsyntax-table-p Return t if ARG is a syntax table. Any vector of 256 elements will do. arguments: (OBJ) Fsyntax-table Return the current syntax table. This is the one specified by the current buffer, or by BUFFER if it is non-nil. arguments: (&optional BUFFER) Fstandard-syntax-table Return the standard syntax table. This is the one used for new buffers. arguments: () Fcopy-syntax-table Construct a new syntax table and return it. It is a copy of the TABLE, which defaults to the standard syntax table. arguments: (&optional TABLE) Fset-syntax-table Select a new syntax table for BUFFER. One argument, a syntax table. BUFFER defaults to the current buffer if omitted. arguments: (TABLE &optional BUFFER) Fsyntax-designator-chars Return a string of the recognized syntax designator chars. The chars are ordered by their internal syntax codes, which are numbered starting at 0. arguments: () Fchar-syntax Return the syntax code of CHAR, described by a character. For example, if CHAR is a word constituent, the character `?w' is returned. The characters that correspond to various syntax codes are listed in the documentation of `modify-syntax-entry'. Optional second argument TABLE defaults to the current buffer's syntax table. arguments: (CH &optional TABLE) Fmatching-paren Return the matching parenthesis of CHAR, or nil if none. Optional second argument TABLE defaults to the current buffer's syntax table. arguments: (CH &optional TABLE) Fforward-word Move point forward ARG words (backward if ARG is negative). Normally returns t. If an edge of the buffer is reached, point is left there and nil is returned. arguments: (COUNT &optional BUFFER) Fforward-comment Move forward across up to N comments. If N is negative, move backward. Stop scanning if we find something other than a comment or whitespace. Set point to where scanning stops. If N comments are found as expected, with nothing except whitespace between them, return t; otherwise return nil. Point is set in either case. Optional argument BUFFER defaults to the current buffer. arguments: (N &optional BUFFER) Fscan-lists Scan from character number FROM by COUNT lists. Returns the character number of the position thus found. If DEPTH is nonzero, paren depth begins counting from that value, only places where the depth in parentheses becomes zero are candidates for stopping; COUNT such places are counted. Thus, a positive value for DEPTH means go out levels. Comments are ignored if `parse-sexp-ignore-comments' is non-nil. If the beginning or end of (the accessible part of) the buffer is reached and the depth is wrong, an error is signaled. If the depth is right but the count is not used up, nil is returned. If optional arg BUFFER is non-nil, scanning occurs in that buffer instead of in the current buffer. If optional arg NOERROR is non-nil, scan-lists will return nil instead of signalling an error. arguments: (FROM COUNT DEPTH &optional BUFFER NO-ERROR) Fscan-sexps Scan from character number FROM by COUNT balanced expressions. If COUNT is negative, scan backwards. Returns the character number of the position thus found. Comments are ignored if `parse-sexp-ignore-comments' is non-nil. If the beginning or end of (the accessible part of) the buffer is reached in the middle of a parenthetical grouping, an error is signaled. If the beginning or end is reached between groupings but before count is used up, nil is returned. If optional arg BUFFER is non-nil, scanning occurs in that buffer instead of in the current buffer. If optional arg NOERROR is non-nil, scan-sexps will return nil instead of signalling an error. arguments: (FROM COUNT &optional BUFFER NO-ERROR) Fbackward-prefix-chars Move point backward over any number of chars with prefix syntax. This includes chars with "quote" or "prefix" syntax (' or p). Optional arg BUFFER defaults to the current buffer. arguments: (&optional BUFFER) Fparse-partial-sexp Parse Lisp syntax starting at FROM until TO; return status of parse at TO. Parsing stops at TO or when certain criteria are met; point is set to where parsing stops. If fifth arg STATE is omitted or nil, parsing assumes that FROM is the beginning of a function. Value is a list of eight elements describing final state of parsing: 0. depth in parens. 1. character address of start of innermost containing list; nil if none. 2. character address of start of last complete sexp terminated. 3. non-nil if inside a string. (It is the character that will terminate the string.) 4. t if inside a comment. 5. t if following a quote character. 6. the minimum paren-depth encountered during this scan. 7. nil if in comment style a, or not in a comment; t if in comment style b If third arg TARGETDEPTH is non-nil, parsing stops if the depth in parentheses becomes equal to TARGETDEPTH. Fourth arg STOPBEFORE non-nil means stop when come to any character that starts a sexp. Fifth arg STATE is an eight-element list like what this function returns. It is used to initialize the state of the parse. Its second and third elements are ignored. Sixth arg COMMENTSTOP non-nil means stop at the start of a comment. arguments: (FROM TO &optional TARGETDEPTH STOPBEFORE OLDSTATE COMMENTSTOP BUFFER) Vparse-sexp-ignore-comments Non-nil means `forward-sexp', etc., should treat comments as whitespace.Vwords-include-escapes Non-nil means `forward-word', etc., should treat escape chars part of words.Fbuffer-syntactic-context Return the syntactic context of BUFFER at point. If BUFFER is nil or omitted, the current buffer is assumed. The returned value is one of the following symbols: nil ; meaning no special interpretation string ; meaning point is within a string comment ; meaning point is within a line comment block-comment ; meaning point is within a block comment See also the function `buffer-syntactic-context-depth', which returns the current nesting-depth within all parenthesis-syntax delimiters and the function `syntactically-sectionize', which will map a function over each syntactic context in a region. WARNING: this may alter match-data. arguments: (&optional BUFFER) Fbuffer-syntactic-context-depth Return the depth within all parenthesis-syntax delimiters at point. If BUFFER is nil or omitted, the current buffer is assumed. WARNING: this may alter match-data. arguments: (&optional BUFFER) Fsyntactically-sectionize Calls FUNCTION for each contiguous syntactic context in the region. Calls the given function with four arguments: the start and end of the region, a symbol representing the syntactic context, and the current depth (as returned by the functions `buffer-syntactic-context' and `buffer-syntactic-context-depth'). When this function is called, the current buffer will be set to BUFFER. WARNING: this may alter match-data. arguments: (FUNCTION START END &optional BUFFER) Fbyte-code Function used internally in byte-compiled code. The first argument is a string of byte code; the second, a vector of constants; the third, the maximum stack depth used in this function. If the third argument is incorrect, Emacs may crash. arguments: (BYTESTR VECTOR MAXDEPTH) Vbyte-code-meter A vector of vectors which holds a histogram of byte-code usage. (aref (aref byte-code-meter 0) CODE) indicates how many times the byte opcode CODE has been executed. (aref (aref byte-code-meter CODE1) CODE2), where CODE1 is not 0, indicates how many times the byte opcodes CODE1 and CODE2 have been executed in succession.Vbyte-metering-on If non-nil, keep profiling information on byte code usage. The variable byte-code-meter indicates how often each byte opcode is used. If a symbol has a property named `byte-code-meter' whose value is an integer, it is incremented each time that symbol's function is called.Fprocessp Return t if OBJECT is a process. arguments: (OBJ) Fprocess-list Return a list of all processes. arguments: () Fget-process Return the process named NAME, or nil if there is none. arguments: (NAME) Fget-buffer-process Return the (or, a) process associated with BUFFER. BUFFER may be a buffer or the name of one. arguments: (NAME) Fprocess-id Return the process id of PROCESS. This is the pid of the Unix process which PROCESS uses or talks to. For a network connection, this value is a cons of (foreign-network-port . foreign-host-name). arguments: (PROC) Fprocess-name Return the name of PROCESS, as a string. This is the name of the program invoked in PROCESS, possibly modified to make it unique among process names. arguments: (PROC) Fprocess-command Return the command that was executed to start PROCESS. This is a list of strings, the first string being the program executed and the rest of the strings being the arguments given to it. arguments: (PROC) Fstart-process-internal Start a program in a subprocess. Return the process object for it. Args are NAME BUFFER PROGRAM &rest PROGRAM-ARGS NAME is name for process. It is modified if necessary to make it unique. BUFFER is the buffer or (buffer-name) to associate with the process. Process output goes at end of that buffer, unless you specify an output stream or filter function to handle the output. BUFFER may be also nil, meaning that this process is not associated with any buffer Third arg is program file name. It is searched for as in the shell. Remaining arguments are strings to give program as arguments. INCODE and OUTCODE specify the coding-system objects used in input/output from/to the process.Fopen-network-stream-internal Open a TCP connection for a service to a host. Returns a subprocess-object to represent the connection. Input and output work as for subprocesses; `delete-process' closes it. Args are NAME BUFFER HOST SERVICE. NAME is name for process. It is modified if necessary to make it unique. BUFFER is the buffer (or buffer-name) to associate with the process. Process output goes at end of that buffer, unless you specify an output stream or filter function to handle the output. BUFFER may be also nil, meaning that this process is not associated with any buffer Third arg is name of the host to connect to, or its IP address. Fourth arg SERVICE is name of the service desired, or an integer specifying a port number to connect to. arguments: (NAME BUFFER HOST SERVICE) Fset-process-window-size Tell PROCESS that it has logical window size HEIGHT and WIDTH. arguments: (PROC HEIGHT WIDTH) Fprocess-tty-name Return the name of the terminal PROCESS uses, or nil if none. This is the terminal that the process itself reads and writes on, not the name of the pty that Emacs uses to talk with that terminal. arguments: (PROC) Fset-process-buffer Set buffer associated with PROCESS to BUFFER (a buffer, or nil). arguments: (PROC BUFFER) Fprocess-buffer Return the buffer PROCESS is associated with. Output from PROCESS is inserted in this buffer unless PROCESS has a filter. arguments: (PROC) Fprocess-mark Return the marker for the end of the last output from PROCESS. arguments: (PROC) Fset-process-filter Give PROCESS the filter function FILTER; nil means no filter. t means stop accepting output from the process. When a process has a filter, each time it does output the entire string of output is passed to the filter. The filter gets two arguments: the process and the string of output. If the process has a filter, its buffer is not used for output. arguments: (PROC FILTER) Fprocess-filter Return the filter function of PROCESS; nil if none. See `set-process-filter' for more info on filter functions. arguments: (PROC) Fprocess-send-region Send current contents of region as input to PROCESS. PROCESS may be a process name or an actual process. Called from program, takes three arguments, PROCESS, START and END. If the region is more than 500 characters long, it is sent in several bunches. This may happen even for shorter regions. Output from processes can arrive in between bunches. arguments: (PROCESS START END) Fprocess-send-string Send PROCESS the contents of STRING as input. PROCESS may be a process name or an actual process. Optional arguments FROM and TO specify part of STRING, see `substring'. If STRING is more than 500 or so characters long, it is sent in several bunches. This may happen even for shorter strings. Output from processes can arrive in between bunches. arguments: (PROCESS STRING &optional FROM TO) Fprocess-input-coding-system Return PROCESS's input coding system. arguments: (PROCESS) Fprocess-output-coding-system Return PROCESS's output coding system. arguments: (PROCESS) Fset-process-input-coding-system Set PROCESS's input coding system to INCODE. arguments: (PROCESS INCODE) Fset-process-output-coding-system Set PROCESS's output coding system to OUTCODE. arguments: (PROCESS OUTCODE) Fset-process-sentinel Give PROCESS the sentinel SENTINEL; nil for none. The sentinel is called as a function when the process changes state. It gets two arguments: the process, and a string describing the change. arguments: (PROC SENTINEL) Fprocess-sentinel Return the sentinel of PROCESS; nil if none. See `set-process-sentinel' for more info on sentinels. arguments: (PROC) Fprocess-status Return the status of PROCESS. This is a symbol, one of these: run -- for a process that is running. stop -- for a process stopped but continuable. exit -- for a process that has exited. signal -- for a process that has got a fatal signal. open -- for a network stream connection that is open. closed -- for a network stream connection that is closed. nil -- if arg is a process name and no such process exists. PROCESS may be a process, a buffer, the name of a process or buffer, or nil, indicating the current buffer's process. arguments: (PROC) Fprocess-exit-status Return the exit status of PROCESS or the signal number that killed it. If PROCESS has not yet exited or died, return 0. arguments: (PROC) Finterrupt-process Interrupt process PROCESS. May be process or name of one. Nil or no arg means current buffer's process. Second arg CURRENT-GROUP non-nil means send signal to the current process-group of the process's controlling terminal rather than to the process's own process group. If the process is a shell, this means interrupt current subjob rather than the shell. arguments: (&optional PROCESS CURRENT-GROUP) Fkill-process Kill process PROCESS. May be process or name of one. See function `interrupt-process' for more details on usage. arguments: (&optional PROCESS CURRENT-GROUP) Fquit-process Send QUIT signal to process PROCESS. May be process or name of one. See function `interrupt-process' for more details on usage. arguments: (&optional PROCESS CURRENT-GROUP) Fstop-process Stop process PROCESS. May be process or name of one. See function `interrupt-process' for more details on usage. arguments: (&optional PROCESS CURRENT-GROUP) Fcontinue-process Continue process PROCESS. May be process or name of one. See function `interrupt-process' for more details on usage. arguments: (&optional PROCESS CURRENT-GROUP) Fsignal-process Send the process with number PID the signal with code CODE. Both PID and CODE are integers. arguments: (PID SIG) Fprocess-send-eof Make PROCESS see end-of-file in its input. PROCESS may be a process, a buffer, the name of a process or buffer, or nil, indicating the current buffer's process. If PROCESS is a network connection, or is a process communicating through a pipe (as opposed to a pty), then you cannot send any more text to PROCESS after you call this function. arguments: (&optional PROCESS) Fdelete-process Delete PROCESS: kill it and forget about it immediately. PROCESS may be a process or the name of one, or a buffer name. arguments: (PROC) Fprocess-kill-without-query Say no query needed if PROCESS is running when Emacs is exited. Optional second argument if non-nil says to require a query. Value is t if a query was formerly required. arguments: (PROC &optional REQUIRE-QUERY-P) Fprocess-kill-without-query-p Whether PROC will be killed without query if running when emacs is exited. arguments: (PROC) Vdelete-exited-processes *Non-nil means delete processes immediately when they exit. nil means don't delete them until `list-processes' is run.Vprocess-connection-type Control type of device used to communicate with subprocesses. Values are nil to use a pipe, or t or `pty' to use a pty. The value has no effect if the system has no ptys or if all ptys are busy: then a pipe is used in any case. The value takes effect when `start-process' is called.Fcall-process-internal Call PROGRAM synchronously in separate process, with coding-system specified. Arguments are (PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS). The program's input comes from file INFILE (nil means `/dev/null'). Insert output in BUFFER before point; t means current buffer; nil for BUFFER means discard it; 0 means discard and don't wait. Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted. Remaining arguments are strings passed as command arguments to PROGRAM. If BUFFER is 0, returns immediately with value nil. Otherwise waits for PROGRAM to terminate and returns a numeric exit status or a signal description string. If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.Fgetenv Return the value of environment variable VAR, as a string. VAR is a string, the name of the variable. When invoked interactively, prints the value in the echo area. arguments: (VAR &optional INTERACTIVEP) Vbinary-process-input *If non-nil then new subprocesses are assumed to take binary input.Vbinary-process-output *If non-nil then new subprocesses are assumed to produce binary output.Vshell-file-name *File name to load inferior shells from. Initialized from the SHELL environment variable.Vexec-path *List of directories to search programs to run in subprocesses. Each element is a string (directory name) or nil (try default directory).Vexec-directory Directory of architecture-dependent files that come with XEmacs, especially executable programs intended for Emacs to invoke.Vdata-directory Directory of architecture-independent files that come with XEmacs, intended for Emacs to use.Vdoc-directory Directory containing the DOC file that comes with XEmacs. This is usually the same as exec-directory.Vprocess-environment List of environment variables for subprocesses to inherit. Each element should be a string of the form ENVVARNAME=VALUE. The environment which Emacs inherits is placed in this variable when Emacs starts.Vconfigure-info-directory For internal use by the build procedure only. This is the name of the directory in which the build procedure installed Emacs's info files; the default value for Info-default-directory-list includes this.Fhashtablep Return t if OBJ is a hashtable, else nil. arguments: (OBJ) Fmake-hashtable Make a hashtable of initial size SIZE. arguments: (SIZE) Fcopy-hashtable Make a new hashtable which contains the same keys and values as the given table. The keys and values will not themselves be copied. arguments: (OLD-TABLE) Fgethash Find hash value for KEY in TABLE. If there is no corresponding value, return DEFAULT (defaults to nil). arguments: (KEY TABLE &optional DEFAULT) Fremhash Remove hash value for KEY in TABLE. arguments: (KEY TABLE) Fputhash Hash KEY to VAL in TABLE. arguments: (KEY VAL TABLE) Fclrhash Flush TABLE. arguments: (TABLE) Fhashtable-fullness Return number of entries in TABLE. arguments: (TABLE) Fmaphash Map FUNCTION over entries in TABLE, calling it with two args, each key and value in the table. arguments: (FUNCTION TABLE) Fmake-weak-hashtable Make a fully weak hashtable of initial size SIZE. A weak hashtable is one whose pointers do not count as GC referents: for any key-value pair in the hashtable, if the only remaining pointer to either the key or the value is in a weak hash table, then the pair will be removed from the table, and the key and value collected. A non-weak hash table (or any other pointer) would prevent the object from being collected. You can also create semi-weak hashtables; see `make-key-weak-hashtable' and `make-value-weak-hashtable'. arguments: (SIZE) Fmake-key-weak-hashtable Make a key-weak hashtable of initial size SIZE. A key-weak hashtable is similar to a fully-weak hashtable (see `make-weak-hashtable') except that a key-value pair will be removed only if the key remains unmarked outside of weak hashtables. The pair will remain in the hashtable if the key is pointed to by something other than a weak hashtable, even if the value is not. arguments: (SIZE) Fmake-value-weak-hashtable Make a value-weak hashtable of initial size SIZE. A value-weak hashtable is similar to a fully-weak hashtable (see `make-weak-hashtable') except that a key-value pair will be removed only if the value remains unmarked outside of weak hashtables. The pair will remain in the hashtable if the value is pointed to by something other than a weak hashtable, even if the key is not. arguments: (SIZE) Fextentp T if OBJECT is an extent. arguments: (OBJECT) Fextent-live-p T if OBJECT is an extent and the extent has not been destroyed. arguments: (OBJECT) Fextent-detached-p T if EXTENT is detached. arguments: (EXTENT) Fextent-buffer Return buffer of EXTENT. arguments: (EXTENT) Fextent-start-position Return start position of EXTENT, or nil if EXTENT is detached. arguments: (EXTENT) Fextent-end-position Return end position of EXTENT, or nil if EXTENT is detached. arguments: (EXTENT) Fextent-length Return length of EXTENT in characters. arguments: (EXTENT) Fnext-extent Find next extent after EXTENT. If EXTENT is a buffer return the first extent in the buffer. Extents in a buffer are ordered in what is called the "display" order, which sorts by increasing start positions and then by *decreasing* end positions. If you want to perform an operation on a series of extents, use `map-extents' instead of this function; it is much more efficient. The primary use of this function should be to enumerate all the extents in a buffer. Note: The display order is not necessarily the order that `map-extents' processes extents in! arguments: (EXTENT) Fprevious-extent Find last extent before EXTENT. If EXTENT is a buffer return the last extent in the buffer. This function is analogous to `next-extent'. arguments: (EXTENT) Fnext-e-extent Find next extent after EXTENT using the "e" order. If EXTENT is a buffer, return the first extent in the buffer. arguments: (EXTENT) Fprevious-e-extent Find last extent before EXTENT using the "e" order. If EXTENT is a buffer return the last extent in the buffer. This function is analogous to `next-e-extent'. arguments: (EXTENT) Fnext-extent-change Return the next position after POS where an extent begins or ends. If POS is at the end of the buffer, POS will be returned; otherwise a position greater than POS will always be returned. If BUFFER is nil, the current buffer is assumed. arguments: (POS &optional BUFFER) Fprevious-extent-change Return the last position before POS where an extent begins or ends. If POS is at the beginning of the buffer, POS will be returned; otherwise a position less than POS will always be returned. If BUFFER is nil, the current buffer is assumed. arguments: (POS &optional BUFFER) Fextent-parent Return the parent (if any) of EXTENT. If an extent has a parent, it derives all its properties from that extent and has no properties of its own. It is possible for an extent's parent to itself have a parent. arguments: (EXTENT) Fextent-children Return a list of the children (if any) of EXTENT. The children of an extent are all those extents whose parent is that extent. This function does not recursively trace children of children. arguments: (EXTENT) Fset-extent-parent Set the parent of EXTENT to PARENT (may be nil). See `extent-parent'. arguments: (EXTENT PARENT) Fmake-extent Make an extent for the range [FROM, TO) in BUFFER-OR-STRING. BUFFER-OR-STRING defaults to the current buffer. (Note: Currently extents over strings are not supported, but will be in the future.) Insertions at point TO will be outside of the extent; insertions at FROM will be inside the extent, causing the extent to grow. (This is the same way that markers behave.) You can change the behavior of insertions at the endpoints using `set-extent-property'. The extent is initially detached if both FROM and TO are nil, and in this case BUFFER-OR-STRING defaults to nil, meaning the extent is in no buffer and no string. arguments: (FROM TO &optional BUFFER-OR-STRING) Fcopy-extent Make a copy of EXTENT. It is initially detached. Optional argument BUFFER-OR-STRING defaults to EXTENT's buffer or string. arguments: (EXTENT &optional BUFFER-OR-STRING) Fdelete-extent Remove EXTENT from its buffer and destroy it. This does not modify the buffer's text, only its display properties. The extent cannot be used thereafter. arguments: (EXTENT) Fdetach-extent Remove EXTENT from its buffer in such a way that it can be re-inserted. An extent is also detached when all of its characters are all killed by a deletion, unless its `detachable' property has been unset. Extents which have the `duplicable' attribute are tracked by the undo mechanism. Detachment via `detach-extent' and string deletion is recorded, as is attachment via `insert-extent' and string insertion. Extent motion, face changes, and attachment via `make-extent' and `set-extent-endpoints' are not recorded. This means that extent changes which are to be undo-able must be performed by character editing, or by insertion and detachment of duplicable extents. arguments: (EXTENT) Fset-extent-endpoints Set the endpoints of EXTENT to START, END. If START and END are null, call detach-extent on EXTENT. See documentation on `detach-extent' for a discussion of undo recording. arguments: (EXTENT START END) Fextent-in-region-p Return whether EXTENT overlaps a specified region. This is equivalent to whether `map-extents' would visit EXTENT when called with these args. arguments: (EXTENT &optional FROM TO FLAGS) Fmap-extents Map FUNCTION over the extents which overlap a region in BUFFER. The region is normally bounded by [FROM, TO) (i.e. the beginning of the region is closed and the end of the region is open), but this can be changed with the FLAGS argument (see below for a complete discussion). FUNCTION is called with the arguments (extent, MAPARG). The arguments BUFFER, FROM, TO, MAPARG, and CLOSED-END are all optional and default to the current buffer, the beginning of BUFFER, the end of BUFFER, nil, and nil, respectively. MAP-EXTENTS returns the first non-nil result produced by FUNCTION, and no more calls to FUNCTION are made after it returns non-nil. If BUFFER is an extent, FROM and TO default to the extent's endpoints, and the mapping omits that extent and its predecessors. This feature supports restarting a loop based on `map-extents'. An extent overlaps the region if there is any point in the extent that is also in the region. (For the purpose of overlap, zero-length extents and regions are treated as closed on both ends regardless of their endpoints' specified open/closedness.) Note that the endpoints of an extent or region are considered to be in that extent or region if and only if the corresponding end is closed. For example, the extent [5,7] overlaps the region [2,5] because 5 is in both the extent and the region. However, (5,7] does not overlap [2,5] because 5 is not in the extent, and neither [5,7] nor (5,7] overlaps the region [2,5) because 5 is not in the region. The optional FLAGS can be a symbol or a list of one or more symbols, modifying the behavior of `map-extents'. Allow symbols are: end-closed The region's end is closed. start-open The region's start is open. all-extents-closed Treat all extents as closed on both ends for the purpose of determining whether they overlap the region, irrespective of their actual open- or closedness. all-extents-open Treat all extents as open on both ends. all-extents-closed-open Treat all extents as start-closed, end-open. all-extents-open-closed Treat all extents as start-open, end-closed. start-in-region In addition to the above conditions for extent overlap, the extent's start position must lie within the specified region. Note that, for this condition, open start positions are treated as if 0.5 was added to the endpoint's value, and open end positions are treated as if 0.5 was subtracted from the endpoint's value. end-in-region The extent's end position must lie within the region. start-and-end-in-region Both the extent's start and end positions must lie within the region. start-or-end-in-region Either the extent's start or end position must lie within the region. negate-in-region The condition specified by a `*-in-region' flag must NOT hold for the extent to be considered. At most one of `all-extents-closed', `all-extents-open', `all-extents-closed-open', and `all-extents-open-closed' may be specified. At most one of `start-in-region', `end-in-region', `start-and-end-in-region', and `start-or-end-in-region' may be specified. If optional arg PROPERTY is non-nil, only extents with that property set on them will be visited. If optional arg VALUE is non-nil, only extents whose value for that property is `eq' to VALUE will be visited. arguments: (FUNCTION &optional BUFFER FROM TO MAPARG FLAGS PROPERTY VALUE) Fmap-extent-children Map FUNCTION over the extents in the region from FROM to TO. FUNCTION is called with arguments (extent, MAPARG). See `map-extents' for a full discussion of the arguments FROM, TO, and FLAGS. The arguments are the same as for `map-extents', but this function differs in that it only visits extents which start in the given region, and also in that, after visiting an extent E, it skips all other extents which start inside E but end before E's end. Thus, this function may be used to walk a tree of extents in a buffer: (defun walk-extents (buffer &optional ignore) (map-extent-children 'walk-extents buffer)) arguments: (FUNCTION &optional BUFFER FROM TO MAPARG FLAGS PROPERTY VALUE) Fextent-at Find "smallest" extent at POS in BUFFER having PROPERTY set. An extent is "at" POS if it overlaps the region (POS, POS+1); i.e. if it covers the character after POS. "Smallest" means the extent that comes last in the display order; this normally means the extent whose start position is closest to POS. See `next-extent' for more information. BUFFER defaults to the current buffer. PROPERTY defaults to nil, meaning that any extent will do. Properties are attached to extents with `set-extent-property', which see. Returns nil if POS is invalid or there is no matching extent at POS. If the fourth argument BEFORE is not nil, it must be an extent; any returned extent will precede that extent. This feature allows `extent-at' to be used by a loop over extents. arguments: (POS &optional BUFFER PROPERTY BEFORE) Fset-extent-begin-glyph Display a bitmap, subwindow or string at the beginning of EXTENT. BEGIN-GLYPH must be a glyph object. The layout policy defaults to `text'. arguments: (EXTENT BEGIN-GLYPH &optional LAYOUT) Fset-extent-end-glyph Display a bitmap, subwindow or string at the end of the EXTENT. END-GLYPH must be a glyph object. The layout policy defaults to `text'. arguments: (EXTENT END-GLYPH &optional LAYOUT) Fextent-begin-glyph Return the glyph object displayed at the beginning of EXTENT. If there is none, nil is returned. arguments: (EXTENT-OBJ) Fextent-end-glyph Return the glyph object displayed at the end of EXTENT. If there is none, nil is returned. arguments: (EXTENT-OBJ) Fset-extent-begin-glyph-layout Set the layout policy of the given extent's begin glyph. Access this using the `extent-begin-glyph-layout' function. arguments: (EXTENT LAYOUT) Fset-extent-end-glyph-layout Set the layout policy of the given extent's end glyph. Access this using the `extent-end-glyph-layout' function. arguments: (EXTENT LAYOUT) Fextent-begin-glyph-layout Return the layout policy associated with the given extent's begin glyph. Set this using the `set-extent-begin-glyph-layout' function. arguments: (EXTENT) Fextent-end-glyph-layout Return the layout policy associated with the given extent's end glyph. Set this using the `set-extent-end-glyph-layout' function. arguments: (EXTENT) Fset-extent-priority Changes the display priority of EXTENT. When the extent attributes are being merged for display, the priority is used to determine which extent takes precedence in the event of a conflict (two extents whose faces both specify font, for example: the font of the extent with the higher priority will be used). Extents are created with priority 0; priorities may be negative. arguments: (EXTENT PRI) Fextent-priority Return the display priority of EXTENT; see `set-extent-priority'. arguments: (EXTENT) Fset-extent-property Change a property of an extent. PROPERTY may be any symbol; the value stored may be accessed with the `extent-property' function. The following symbols have predefined meanings: detached Removes the extent from its buffer; setting this is the same as calling `detach-extent'. destroyed Removes the extent from its buffer, and makes it unusable in the future; this is the same calling `delete-extent'. priority Change redisplay priority; same as `set-extent-priority'. start-open Whether the set of characters within the extent is treated being open on the left, that is, whether the start position is an exclusive, rather than inclusive, boundary. If true, then characters inserted exactly at the beginning of the extent will remain outside of the extent; otherwise they will go into the extent, extending it. end-open Whether the set of characters within the extent is treated being open on the right, that is, whether the end position is an exclusive, rather than inclusive, boundary. If true, then characters inserted exactly at the end of the extent will remain outside of the extent; otherwise they will go into the extent, extending it. By default, extents have the `end-open' but not the `start-open' property set. read-only Text within this extent will be unmodifiable. detachable Whether the extent gets detached (as with `detach-extent') when all the text within the extent is deleted. This is true by default. If this property is not set, the extent becomes a zero-length extent when its text is deleted. (In such a case, the `start-open' property is automatically removed if both the `start-open' and `end-open' properties are set, since zero-length extents open on both ends are not allowed.) face The face in which to display the text. Setting this is the same as calling `set-extent-face'. highlight Highlight the extent when the mouse moves over it. duplicable Whether this extent should be copied into strings, so that kill, yank, and undo commands will restore or copy it. unique Meaningful only in conjunction with `duplicable'. When this is set, there may be only one instance of this extent attached at a time: if it is copied to the kill ring and then yanked, the extent is not copied. If, however, it is killed (removed from the buffer) and then yanked, it will be re-attached at the new position. invisible Text under this extent is treated as not present for the purpose of redisplay. The text is still visible to other functions that examine a buffer's text, however. intangible (not yet implemented) Text under this extent is treated as not present. Neither redisplay nor any other functions that examine a buffer's text will see the text under this extent. keymap This keymap is consulted for mouse clicks on this extent, or keypresses made while point is within the extent. copy-function This is a hook that is run when a duplicable extent is about to be copied from a buffer to a string (or the kill ring). It is called with three arguments, the extent, and the buffer-positions within it which are being copied. If this function returns nil, then the extent will not be copied; otherwise it will. paste-function This is a hook that is run when a duplicable extent is about to be copied from a string (or the kill ring) into a buffer. It is called with three arguments, the original extent, and the buffer positions which the copied extent will occupy. (This hook is run after the corresponding text has already been inserted into the buffer.) Note that the extent argument may be detached when this function is run. If this function returns nil, no extent will be inserted. Otherwise, there will be an extent covering the range in question. If the original extent is not attached to a buffer, then it will be re-attached at this range. Otherwise, a copy will be made, and that copy attached here. The copy-function and paste-function are meaningful only for extents with the `duplicable' flag set, and if they are not specified, behave as if `t' was the returned value. When these hooks are invoked, the current buffer is the buffer which the extent is being copied from/to, respectively. arguments: (EXTENT PROPERTY VALUE) Fextent-property Return EXTENT's value for property PROPERTY. See `set-extent-property' for the built-in property names. arguments: (EXTENT PROPERTY) Fextent-properties Return a property list of the attributes of the given extent. Do not modify this list; use `set-extent-property' instead. arguments: (EXTENT) Fforce-highlight-extent Highlight or unhighlight the given extent. If the second arg is non-nil, it will be highlighted, else dehighlighted. This is the same as `highlight-extent', except that it will work even on extents without the 'highlight property. arguments: (EXTENT-OBJ &optional HIGHLIGHT-P) Fhighlight-extent Highlight the given extent, if it is highlightable (that is, if it has the 'highlight property). If the second arg is non-nil, it will be highlighted, else dehighlighted. Highlighted extents are displayed as if they were merged with the 'highlight face. arguments: (EXTENT-OBJ &optional HIGHLIGHT-P) Finsert-extent Insert EXTENT from START to END in the current buffer. This operation does not insert any characters, but otherwise acts like `insert' of a string whose string-extent-data calls for EXTENT to be inserted. Returns the newly-inserted extent. The fourth arg, NO-HOOKS, can be used to inhibit the running of the extent's `paste-function' property if it has one. See documentation on `detach-extent' for a discussion of undo recording. arguments: (EXTENT &optional START END NO-HOOKS) Fstring-extent-data Return the saved extent data associated with the given string. NOTE: this function may go away in the future, in favor of making `map-extents' accept a string as an argument. The format is a list of extent-replica objects, each with an extent and start and end positions within the string itself. Set this using the `set-string-extent-data' function. The `concat' function logically concatenates this list, reconstructing the extent information with adjusted start and end positions. When `buffer-substring' or a similar function creates a string, it stores an entry on this list for every `duplicable' extent overlapping the string. See `set-extent-property'. When `insert' or a similar function inserts the string into a buffer, each saved extent is copied into the buffer. If the saved extent is already in the buffer at an adjacent location, it is extended. If the saved extent is detached from the buffer, it is reattached. If the saved extent is already attached, or is detached from a different buffer, it is copied as if by `copy-extent', and the extent's `paste-function' is consulted. This entire sequence of events is also available in the function `insert-extent'. arguments: (STRING) Fset-string-extent-data Set the saved extent data associated with the given string. Access this using the `string-extent-data' function. arguments: (STRING DATA) Fmake-extent-replica Make an object suitable for use with `set-string-extent-data'. The arguments are EXTENT, START, and END. There are no mutator functions for this data structure, only accessors. arguments: (EXTENT START END) Fextent-replica-p T if OBJECT is an extent replica. arguments: (OBJECT) Fextent-replica-live-p T if OBJECT is an extent replica that has not been destroyed. arguments: (OBJECT) Fextent-replica-extent Return the extent of the specified extent replica. See `make-extent-replica'. arguments: (EXTENT-REPLICA) Fextent-replica-start Return the start of the specified extent replica. See `make-extent-replica'. arguments: (EXTENT-REPLICA) Fextent-replica-end Return the end of the specified extent replica. See `make-extent-replica'. arguments: (EXTENT-REPLICA) Fput-text-property Adds the given property/value to all characters in the specified region. The property is conceptually attached to the characters rather than the region. The properties are copied when the characters are copied/pasted. arguments: (START END PROP VALUE &optional BUFFER) Fput-nonduplicable-text-property Adds the given property/value to all characters in the specified region. The property is conceptually attached to the characters rather than the region, however the properties will not be copied when the characters are copied. arguments: (START END PROP VALUE &optional BUFFER) Fadd-text-properties Add properties to the characters from START to END. The third argument PROPS is a property list specifying the property values to add. The optional fourth argument, OBJECT, is the buffer containing the text. Returns t if any property was changed, nil otherwise. arguments: (START END PROPS &optional BUFFER) Fremove-text-properties Remove the given properties from all characters in the specified region. PROPS should be a plist, but the values in that plist are ignored (treated as nil). Returns t if any property was changed, nil otherwise. arguments: (START END PROPS &optional BUFFER) Ftext-prop-extent-paste-function Used as the `paste-function' property of `text-prop' extents. arguments: (EXTENT FROM TO) Fnext-single-property-change Return the position of next property change for a specific property. Scans characters forward from POS till it finds a change in the PROP property, then returns the position of the change. The optional third argument BUFFER is the buffer to scan (defaults to the current buffer). The property values are compared with `eq'. Return nil if the property is constant all the way to the end of BUFFER. If the value is non-nil, it is a position greater than POS, never equal. If the optional fourth argument LIMIT is non-nil, don't search past position LIMIT; return LIMIT if nothing is found before LIMIT. If two or more extents with conflicting non-nil values for PROP overlap a particular character, it is undefined which value is considered to be the value of PROP. (Note that this situation will not happen if you always use the text-property primitives.) arguments: (POS PROP &optional BUFFER LIMIT) Fprevious-single-property-change Return the position of next property change for a specific property. Scans characters backward from POS till it finds a change in the PROP property, then returns the position of the change. The optional third argument BUFFER is the buffer to scan (defaults to the current buffer). The property values are compared with `eq'. Return nil if the property is constant all the way to the start of BUFFER. If the value is non-nil, it is a position less than POS, never equal. If the optional fourth argument LIMIT is non-nil, don't search back past position LIMIT; return LIMIT if nothing is found until LIMIT. If two or more extents with conflicting non-nil values for PROP overlap a particular character, it is undefined which value is considered to be the value of PROP. (Note that this situation will not happen if you always use the text-property primitives.) arguments: (POS PROP &optional BUFFER LIMIT) Vmouse-highlight-priority The priority to use for the mouse-highlighting pseudo-extent that is used to highlight extents with the `highlight' attribute set. See `set-extent-priority'.Fwaiting-for-user-input-p Return non-nil if XEmacs is waiting for input from the user. This is intended for use by asynchronous timeout callbacks and by asynchronous process output filters and sentinels (not yet implemented in XEmacs). It will always be nil if XEmacs is not inside of an asynchronout timeout or process callback. arguments: () Fplay-sound-file Play the named sound file on DEVICE's speaker at the specified volume (0-100, default specified by the `bell-volume' variable). The sound file must be in the Sun/NeXT U-LAW format. DEVICE defaults to the selected device. arguments: (FILE &optional VOLUME DEVICE) Fplay-sound Play a sound of the provided type. See the variable `sound-alist'. arguments: (SOUND &optional VOLUME DEVICE) Fding Beep, or flash the frame. Also, unless an argument is given, terminate any keyboard macro currently executing. When called from lisp, the second argument is what sound to make, and the third argument is the device to make it in (defaults to the selected device). arguments: (&optional ARG SOUND DEVICE) Fwait-for-sounds Wait for all sounds to finish playing on DEVICE. arguments: (&optional DEVICE) Fconnected-to-nas-p t if connected to NAS server for sounds on DEVICE. arguments: (&optional DEVICE) Vbell-volume *How loud to be, from 0 to 100.Vsound-alist An alist associating names with sounds. When `beep' or `ding' is called with one of the name symbols, the associated sound will be generated instead of the standard beep. Each element of `sound-alist' is a list describing a sound. The first element of the list is the name of the sound being defined. Subsequent elements of the list are alternating keyword/value pairs: Keyword: Value: ------- ----- sound A string of raw sound data, or the name of another sound to play. The symbol `t' here means use the default X beep. volume An integer from 0-100, defaulting to `bell-volume' pitch If using the default X beep, the pitch (Hz) to generate. duration If using the default X beep, the duration (milliseconds). For compatibility, elements of `sound-alist' may also be: ( sound-name . <sound> ) ( sound-name <volume> <sound> ) You should probably add things to this list by calling the function load-sound-file. Caveats: - You can only play audio data if running on the console screen of a Sun SparcStation, SGI, or HP9000s700. - The pitch, duration, and volume options are available everywhere, but many X servers ignore the `pitch' option. The following beep-types are used by emacs itself: auto-save-error when an auto-save does not succeed command-error when the emacs command loop catches an error undefined-key when you type a key that is undefined undefined-click when you use an undefined mouse-click combination no-completion during completing-read y-or-n-p when you type something other than 'y' or 'n' yes-or-no-p when you type something other than 'yes' or 'no' default used when nothing else is appropriate. Other lisp packages may use other beep types, but these are the ones that the C kernel of Emacs uses.Vsynchronous-sounds Play sounds synchronously, if non-nil. Only applies if NAS is used and supports asynchronous playing of sounds. Otherwise, sounds are always played synchronously.Vnative-sound-only-on-console Non-nil value means play sounds only if XEmacs is running on the system console. Nil means always always play sounds, even if running on a non-console tty or a secondary X display. This variable only applies to native sound support.Ffacep Return non-nil if OBJECT is a face. arguments: (OBJECT) Ffind-face Retrieve the face of the given name. If FACE-OR-NAME is a face object, it is simply returned. Otherwise, FACE-OR-NAME should be a symbol. If there is no such face, nil is returned. Otherwise the associated face object is returned. arguments: (FACE-OR-NAME) Fget-face Retrieve the face of the given name. Same as `find-face' except an error is signalled if there is no such face instead of returning nil. arguments: (NAME) Fface-name Return the name of the given face. arguments: (FACE) Fface-ascent Return the ascent portion of the FACE's height in the given DOMAIN. If DOMAIN is nil, it will be determined from the selected window. arguments: (FACE &optional DOMAIN) Fface-descent Return the descent portion of the FACE's height in the given DOMAIN. If DOMAIN is nil, it will be determined from the selected window. arguments: (FACE &optional DOMAIN) Fface-width Return the width of FACE in the given DOMAIN. If DOMAIN is nil, it will be determined from the selected window. arguments: (FACE &optional DOMAIN) Fface-list Return a list of the names of all defined faces. If TEMPORARY is nil, only the permanent faces are included. If it is t, only the temporary faces are included. If it is any other non-nil value both permanent and temporary are included. arguments: (&optional TEMPORARY) Fextent-face Return the name of the face in which EXTENT is displayed, or nil if the extent's face is unspecified. arguments: (EXTENT) Fset-extent-face Make the given EXTENT have the graphic attributes specified by FACE. arguments: (EXTENT FACE) Fmake-face Defines and returns a new FACE described by DOC-STRING. You can modify the font, color, etc of a face with the set-face- functions. If the face already exists, it is unmodified. If TEMPORARY is non-nil, this face will cease to exist if not in use. arguments: (NAME &optional DOC-STRING TEMPORARY) Fcopy-face Defines and returns a new face which is a copy of an existing one, or makes an already-existing face be exactly like another. LOCALE, TAG-SET, EXACT-P, and HOW-TO-ADD are as in `copy-specifier'. arguments: (OLD-FACE NEW-NAME &optional LOCALE TAG-SET EXACT-P HOW-TO-ADD) Fvalid-specifier-type-p Given a SPECIFIER-TYPE, return non-nil if it is valid. Valid types are 'generic, 'integer, boolean, 'color, 'font, 'image, 'face-boolean, and 'toolbar. arguments: (SPECIFIER-TYPE) Fspecifier-type-list Return a list of valid specifier types. arguments: () Fmake-specifier Create a new specifier. A specifier is an object that can be used to keep track of a property whose value can be per-buffer, per-window, per-frame, or per-device, and can further be restricted to a particular device-type or device-class. Specifiers are used, for example, for the various built-in properties of a face; this allows a face to have different values in different frames, buffers, etc. For more information, see `specifier-instance', `specifier-specs', and `add-spec-to-specifier'; or, for a detailed description of specifiers, including how they are instantiated over a particular domain (i.e. how their value in that domain is determined), see the chapter on specifiers in the XEmacs Lisp Reference Manual. TYPE specifies the particular type of specifier, and should be one of the symbols 'generic, 'integer, 'boolean, 'color, 'font, 'image, 'face-boolean, or 'toolbar. For more information on particular types of specifiers, see the functions `generic-specifier-p', `integer-specifier-p', `boolean-specifier-p', `color-specifier-p', `font-specifier-p', `image-specifier-p', `face-boolean-specifier-p', and `toolbar-specifier-p'. arguments: (TYPE) Fspecifierp Return non-nil if OBJECT is a specifier. A specifier is an object that can be used to keep track of a property whose value can be per-buffer, per-window, per-frame, or per-device, and can further be restricted to a particular device-type or device-class. See `make-specifier'. arguments: (OBJECT) Fspecifier-type Return the type of SPECIFIER. arguments: (SPECIFIER) Fvalid-specifier-locale-p Return non-nil if LOCALE is a valid specifier locale. Valid locales are a device, a frame, a window, a buffer, and 'global. (nil is not valid.) arguments: (LOCALE) Fvalid-specifier-domain-p Return non-nil if DOMAIN is a valid specifier domain. A domain is used to instance a specifier (i.e. determine the specifier's value in that domain). Valid domains are a window, frame, or device. (nil is not valid.) arguments: (DOMAIN) Fvalid-specifier-locale-type-p Given a specifier LOCALE-TYPE, return non-nil if it is valid. Valid locale types are 'global, 'device, 'frame, 'window, and 'buffer. (Note, however, that in functions that accept either a locale or a locale type, 'global is considered an individual locale.) arguments: (LOCALE-TYPE) Fspecifier-locale-type-from-locale Given a specifier LOCALE, return its type. arguments: (LOCALE) Fvalid-specifier-tag-p Return non-nil if TAG is a valid specifier tag. See also `valid-specifier-tag-set-p'. arguments: (TAG) Fvalid-specifier-tag-set-p Return non-nil if TAG-SET is a valid specifier tag set. A specifier tag set is an entity that is attached to an instantiator and can be used to restrict the scope of that instantiator to a particular device class or device type and/or to mark instantiators added by a particular package so that they can be later removed. A specifier tag set consists of a list of zero of more specifier tags, each of which is a symbol that is recognized by XEmacs as a tag. (The valid device types and device classes are always tags, as are any tags defined by `define-specifier-tag'.) It is called a "tag set" (as opposed to a list) because the order of the tags or the number of times a particular tag occurs does not matter. Each tag has a predicate associated with it, which specifies whether that tag applies to a particular device. The tags which are device types and classes match devices of that type or class. User-defined tags can have any predicate, or none (meaning that all devices match). When attempting to instance a specifier, a particular instantiator is only considered if the device of the domain being instanced over matches all tags in the tag set attached to that instantiator. Most of the time, a tag set is not specified, and the instantiator gets a null tag set, which matches all devices. arguments: (TAG-SET) Fcanonicalize-tag-set Canonicalize the given tag set. Two canonicalized tag sets can be compared with `equal' to see if they represent the same tag set. (Specifically, canonicalizing involves sorting by symbol name and removing duplicates.) arguments: (TAG-SET) Fdevice-matches-specifier-tag-set-p Return non-nil if DEVICE matches specifier tag set TAG-SET. This means that DEVICE matches each tag in the tag set. (Every tag recognized by XEmacs has a predicate associated with it that specifies which devices match it.) arguments: (DEVICE TAG-SET) Fdefine-specifier-tag Define a new specifier tag. If PREDICATE is specified, it should be a function of one argument (a device) that specifies whether the tag matches that particular device. If PREDICATE is omitted, the tag matches all devices. You can redefine an existing user-defined specifier tag. However, you cannot redefine the built-in specifier tags (the device types and classes) or the symbols nil, t, 'all, or 'global. arguments: (TAG &optional PREDICATE) Fdevice-matching-specifier-tag-list Return a list of all specifier tags matching DEVICE. DEVICE defaults to the selected device if omitted. arguments: (&optional DEVICE) Fspecifier-tag-list Return a list of all currently-defined specifier tags. This includes the built-in ones (the device types and classes). arguments: () Fspecifier-tag-predicate Return the predicate for the given specifier tag. arguments: (TAG) Fcheck-valid-instantiator Signal an error if INSTANTIATOR is invalid for SPECIFIER-TYPE. arguments: (INSTANTIATOR SPECIFIER-TYPE) Fvalid-instantiator-p Return non-nil if INSTANTIATOR is valid for SPECIFIER-TYPE. arguments: (INSTANTIATOR SPECIFIER-TYPE) Fcheck-valid-inst-list Signal an error if INST-LIST is invalid for specifier type TYPE. arguments: (INST-LIST TYPE) Fvalid-inst-list-p Return non-nil if INST-LIST is valid for specifier type TYPE. arguments: (INST-LIST TYPE) Fcheck-valid-spec-list Signal an error if SPEC-LIST is invalid for specifier type TYPE. arguments: (SPEC-LIST TYPE) Fvalid-spec-list-p Return non-nil if SPEC-LIST is valid for specifier type TYPE. arguments: (SPEC-LIST TYPE) Fadd-spec-to-specifier Add a specification to SPECIFIER. The specification maps from LOCALE (which should be a buffer, window, frame, device, or 'global, and defaults to 'global) to INSTANTIATOR, whose allowed values depend on the type of the specifier. Optional argument TAG-SET limits the instantiator to apply only to the specified tag set, which should be a list of tags all of which must match the device being instantiated over (tags are a device type, a device class, or tags defined with `define-specifier-tag'). Specifying a single symbol for TAG-SET is equivalent to specifying a one-element list containing that symbol. Optional argument HOW-TO-ADD specifies what to do if there are already specifications in the specifier. It should be one of 'prepend Put at the beginning of the current list of instantiators for LOCALE. 'append Add to the end of the current list of instantiators for LOCALE. 'remove-tag-set-prepend (this is the default) Remove any existing instantiators whose tag set is the same as TAG-SET; then put the new instantiator at the beginning of the current list. ("Same tag set" means that they contain the same elements. The order may be different.) 'remove-tag-set-append Remove any existing instantiators whose tag set is the same as TAG-SET; then put the new instantiator at the end of the current list. 'remove-locale Remove all previous instantiators for this locale before adding the new spec. 'remove-locale-type Remove all specifications for all locales of the same type as LOCALE (this includes LOCALE itself) before adding the new spec. 'remove-all Remove all specifications from the specifier before adding the new spec. You can retrieve the specifications for a particular locale or locale type with the function `specifier-spec-list' or `specifier-specs'. arguments: (SPECIFIER INSTANTIATOR &optional LOCALE TAG-SET HOW-TO-ADD) Fadd-spec-list-to-specifier Add a spec-list (a list of specifications) to SPECIFIER. The format of a spec-list is ((LOCALE (TAG-SET . INSTANTIATOR) ...) ...) where LOCALE := a buffer, a window, a frame, a device, or 'global TAG-SET := an unordered list of zero or more TAGS, each of which is a symbol TAG := a device class (see `valid-device-class-p'), a device type (see `valid-device-type-p'), or a tag defined with `define-specifier-tag' INSTANTIATOR := format determined by the type of specifier The pair (TAG-SET . INSTANTIATOR) is called an `inst-pair'. A list of inst-pairs is called an `inst-list'. The pair (LOCALE . INST-LIST) is called a `specification' or `spec'. A spec-list, then, can be viewed as a list of specifications. HOW-TO-ADD specifies how to combine the new specifications with the existing ones, and has the same semantics as for `add-spec-to-specifier'. In many circumstances, the higher-level function `set-specifier' is more convenient and should be used instead. arguments: (SPECIFIER SPEC-LIST &optional HOW-TO-ADD) Fspecifier-spec-list Return the spec-list of specifications for SPECIFIER in LOCALE. If LOCALE is a particular locale (a buffer, window, frame, device, or 'global), a spec-list consisting of the specification for that locale will be returned. If LOCALE is a locale type (i.e. 'buffer, 'window, 'frame, or 'device), a spec-list of the specifications for all locales of that type will be returned. If LOCALE is nil or 'all, a spec-list of all specifications in SPECIFIER will be returned. LOCALE can also be a list of locales, locale types, and/or 'all; the result is as if `specifier-spec-list' were called on each element of the list and the results concatenated together. Only instantiators where TAG-SET (a list of zero or more tags) is a subset of (or possibly equal to) the instantiator's tag set are returned. (The default value of nil is a subset of all tag sets, so in this case no instantiators will be screened out.) If EXACT-P is non-nil, however, TAG-SET must be equal to an instantiator's tag set for the instantiator to be returned. arguments: (SPECIFIER &optional LOCALE TAG-SET EXACT-P) Fspecifier-specs Return the specification(s) for SPECIFIER in LOCALE. If LOCALE is a single locale or is a list of one element containing a single locale, then a "short form" of the instantiators for that locale will be returned. Otherwise, this function is identical to `specifier-spec-list'. The "short form" is designed for readability and not for ease of use in Lisp programs, and is as follows: 1. If there is only one instantiator, then an inst-pair (i.e. cons of tag and instantiator) will be returned; otherwise a list of inst-pairs will be returned. 2. For each inst-pair returned, if the instantiator's tag is 'any, the tag will be removed and the instantiator itself will be returned instead of the inst-pair. 3. If there is only one instantiator, its value is nil, and its tag is 'any, a one-element list containing nil will be returned rather than just nil, to distinguish this case from there being no instantiators at all. arguments: (SPECIFIER &optional LOCALE TAG-SET EXACT-P) Fremove-specifier Remove specification(s) for SPECIFIER. If LOCALE is a particular locale (a buffer, window, frame, device, or 'global), the specification for that locale will be removed. If instead, LOCALE is a locale type (i.e. 'buffer, 'window, 'frame, or 'device), the specifications for all locales of that type will be removed. If LOCALE is nil or 'all, all specifications will be removed. LOCALE can also be a list of locales, locale types, and/or 'all; this is equivalent to calling `remove-specifier' for each of the elements in the list. Only instantiators where TAG-SET (a list of zero or more tags) is a subset of (or possibly equal to) the instantiator's tag set are removed. (The default value of nil is a subset of all tag sets, so in this case no instantiators will be screened out.) If EXACT-P is non-nil, however, TAG-SET must be equal to an instantiator's tag set for the instantiator to be removed. arguments: (SPECIFIER &optional LOCALE TAG-SET EXACT-P) Fcopy-specifier Copy SPECIFIER to DEST, or create a new one if DEST is nil. If DEST is nil or omitted, a new specifier will be created and the specifications copied into it. Otherwise, the specifications will be copied into the existing specifier in DEST. If LOCALE is nil or 'all, all specifications will be copied. If LOCALE is a particular locale, the specification for that particular locale will be copied. If LOCALE is a locale type, the specifications for all locales of that type will be copied. LOCALE can also be a list of locales, locale types, and/or 'all; this is equivalent to calling `copy-specifier' for each of the elements of the list. See `specifier-spec-list' for more information about LOCALE. Only instantiators where TAG-SET (a list of zero or more tags) is a subset of (or possibly equal to) the instantiator's tag set are copied. (The default value of nil is a subset of all tag sets, so in this case no instantiators will be screened out.) If EXACT-P is non-nil, however, TAG-SET must be equal to an instantiator's tag set for the instantiator to be copied. Optional argument HOW-TO-ADD specifies what to do with existing specifications in DEST. If nil, then whichever locales or locale types are copied will first be completely erased in DEST. Otherwise, it is the same as in `add-spec-to-specifier'. arguments: (SPECIFIER &optional DEST LOCALE TAG-SET EXACT-P HOW-TO-ADD) Fspecifier-fallback Return the fallback value for SPECIFIER. Fallback values are provided by the C code for certain built-in specifiers to make sure that instancing won't fail even if all specs are removed from the specifier, or to implement simple inheritance behavior (e.g. this method is used to ensure that faces other than 'default inherit their attributes from 'default). By design, you cannot change the fallback value, and specifiers created with `make-specifier' will never have a fallback (although a similar, Lisp-accessible capability may be provided in the future to allow for inheritance). The fallback value will be an inst-list that is instanced like any other inst-list, a specifier of the same type as SPECIFIER (results in inheritance), or nil for no fallback. When you instance a specifier, you can explicitly request that the fallback not be consulted. (The C code does this, for example, when merging faces.) See `specifier-instance'. arguments: (SPECIFIER) Fspecifier-instance Instantiate SPECIFIER (return its value) in DOMAIN. If no instance can be generated for this domain, return DEFAULT. DOMAIN should be a window, frame, or device. Other values that are legal as a locale (e.g. a buffer) are not valid as a domain because they do not provide enough information to identify a particular device (see `valid-specifier-domain-p'). DOMAIN defaults to the selected window if omitted. "Instantiating" a specifier in a particular domain means determining the specifier's "value" in that domain. This is accomplished by searching through the specifications in the specifier that correspond to all locales that can be derived from the given domain, from specific to general. In most cases, the domain is an Emacs window. In that case specifications are searched for as follows: 1. A specification whose locale is the window's buffer; 2. A specification whose locale is the window itself; 3. A specification whose locale is the window's frame; 4. A specification whose locale is the window's frame's device; 5. A specification whose locale is 'global. If all of those fail, then the C-code-provided fallback value for this specifier is consulted (see `specifier-fallback'). If it is an inst-list, then this function attempts to instantiate that list just as when a specification is located in the first five steps above. If the fallback is a specifier, `specifier-instance' is called recursively on this specifier and the return value used. Note, however, that if the optional argument NO-FALLBACK is non-nil, the fallback value will not be consulted. Note that there may be more than one specification matching a particular locale; all such specifications are considered before looking for any specifications for more general locales. Any particular specification that is found may be rejected because its tag set does not match the device being instantiated over, or because the specification is not valid for the device of the given domain (e.g. the font or color name does not exist for this particular X server). The returned value is dependent on the type of specifier. For example, for a font specifier (as returned by the `face-font' function), the returned value will be a font-instance object. For glyphs, the returned value will be a string, pixmap, or subwindow. arguments: (SPECIFIER &optional DOMAIN DEFAULT NO-FALLBACK) Fspecifier-instance-from-inst-list Attempt to convert a particular inst-list into an instance. This attempts to instantiate INST-LIST in the given DOMAIN, as if INST-LIST existed in a specification in SPECIFIER. If the instantiation fails, DEFAULT is returned. In most circumstances, you should not use this function; use `specifier-instance' instead. arguments: (SPECIFIER DOMAIN INST-LIST &optional DEFAULT) Fgeneric-specifier-p Return non-nil if OBJECT is a generic specifier. A generic specifier allows any kind of Lisp object as an instantiator, and returns back the Lisp object unchanged when it is instantiated. arguments: (OBJECT) Finteger-specifier-p Return non-nil if OBJECT is an integer specifier. arguments: (OBJECT) Fnatnum-specifier-p Return non-nil if OBJECT is a natnum (non-negative-integer) specifier. arguments: (OBJECT) Fboolean-specifier-p Return non-nil if OBJECT is an boolean specifier. arguments: (OBJECT) Fvalid-image-instantiator-type-p Given an IMAGE-INSTANTIATOR-TYPE, return non-nil if it is valid. Valid types are some subset of 'nothing, 'string, 'formatted-string, 'xpm, 'xbm, 'xface, 'gif, 'jpeg, 'png, 'autodetect, and 'subwindow, depending on how XEmacs was compiled. arguments: (IMAGE-INSTANTIATOR-TYPE) Fimage-instantiator-type-list Return a list of valid image-instantiator types. arguments: () Fset-device-type-image-conversion-list Set the image-conversion-list for devices of the given TYPE. The image-conversion-list specifies how image instantiators that are strings should be interpreted. Each element of the list should be a list of two elements (a regular expression string and a vector) or a list of three elements (the preceding two plus an integer index into the vector). The string is converted to the vector associated with the first matching regular expression. If a vector index is specified, the string itself is substituted into that position in the vector. Note: The conversion above is applied when the image instantiator is added to an image specifier, not when the specifier is actually instantiated. Therefore, changing the image-conversion-list only affects newly-added instantiators. Existing instantiators in glyphs and image specifiers will not be affected. arguments: (DEVICE-TYPE LIST) Fdevice-type-image-conversion-list Return the image-conversion-list for devices of the given TYPE. The image-conversion-list specifies how to interpret image string instantiators for the specified device type. See `set-device-type-image-conversion-list' for a description of its syntax. arguments: (DEVICE-TYPE) Fvalid-image-instance-type-p Given an IMAGE-INSTANCE-TYPE, return non-nil if it is valid. Valid types are some subset of 'nothing, 'text, 'mono-pixmap, 'color-pixmap, 'cursor, and 'subwindow, depending on how XEmacs was compiled. arguments: (IMAGE-INSTANCE-TYPE) Fimage-instance-type-list Return a list of valid image-instance types. arguments: () Fmake-image-instance Create a new `image-instance' object. Image-instance objects encapsulate the way a particular image (pixmap, etc.) is displayed on a particular device. In most circumstances, you do not need to directly create image instances; use a glyph or an image- specifier instead. (Most functions and data structures that want an image are designed to take either a glyph or an image-specifier.) DATA is an image instantiator; see `image-specifier-p' for a description of the allowed values. arguments: (DATA &optional DEVICE DEST-TYPES NO-ERROR) Fimage-instance-p Return non-nil if OBJECT is an image instance. arguments: (OBJECT) Fimage-instance-type Return the type of the given image instance. The return value will be one of 'nothing, 'text, 'mono-pixmap, 'color-pixmap, 'cursor, or 'subwindow. arguments: (IMAGE-INSTANCE) Fimage-instance-name Return the name of the given image instance. arguments: (IMAGE-INSTANCE) Fimage-instance-string Return the string of the given image instance. arguments: (IMAGE-INSTANCE) Fimage-instance-file-name Return the file name from which IMAGE-INSTANCE was read, if known. arguments: (IMAGE-INSTANCE) Fimage-instance-mask-file-name Return the file name from which IMAGE-INSTANCE's mask was read, if known. arguments: (IMAGE-INSTANCE) Fimage-instance-depth Return the depth of the image instance. This is 0 for a bitmap, or a positive integer for a pixmap. arguments: (IMAGE-INSTANCE) Fimage-instance-height Return the height of the image instance, in pixels. arguments: (IMAGE-INSTANCE) Fimage-instance-width Return the width of the image instance, in pixels. arguments: (IMAGE-INSTANCE) Fset-image-instance-hotspot Set the image instance's hotspot. This is a point relative to the origin of the pixmap. When a pixmap is used as a cursor or similar pointing indicator, the hotspot is the point on the pixmap that sits over the location that the pointer points to. This is, for example, the tip of the arrow or the center of the crosshairs. arguments: (IMAGE-INSTANCE X Y) Fimage-instance-hotspot-x Return the X coordinate of the image instance's hotspot. See `set-image-instance-hotspot'. arguments: (IMAGE-INSTANCE) Fimage-instance-hotspot-y Return the Y coordinate of the image instance's hotspot. See `set-image-instance-hotspot'. arguments: (IMAGE-INSTANCE) Fimage-specifier-p Return non-nil if OBJECT is an image specifier. An image specifier is used for images (pixmaps and the like). It is used to describe the actual image in a glyph. It is instanced as an image- instance. An image instantiator should be a string or a vector of the form [TYPE :KEYWORD VALUE ...] i.e. a type symbol followed by zero or more alternating keyword-value pairs. TYPE should be one of 'nothing (Don't display anything; no keywords are valid for this.) 'string (Display this image as a text string.) 'formatted-string (Display this image as a text string, with replaceable fields; #### not implemented in 19.13.) 'xbm (An X bitmap; only if X support was compiled into this XEmacs.) 'xpm (An XPM pixmap; only if XPM support was compiled into this XEmacs.) 'xface (An X-Face bitmap, used to encode people's faces in e-mail messages; only if X-Face support was compiled into this XEmacs.) 'gif (A GIF87 or GIF89 image; only if GIF support was compiled into this XEmacs.) 'jpeg (A JPEG image; only if JPEG support was compiled into this XEmacs.) 'png (A PNG/GIF24 image; only if PNG support was compiled into this XEmacs.) 'autodetect (XEmacs tries to guess what format the data is in. If X support exists, the data string will be checked to see if it names a filename. If so, and this filename contains XBM or XPM data, the appropriate sort of pixmap will be created. Otherwise, the image will be displayed as a string. If no X support exists, the image will always be displayed as a string.) The valid keywords are: :data (Inline data. For most formats above, this should be a string. For XBM images, this should be a cons of three elements: width, height, and a string of bit data.) :file (Data is contained in a file. The value is the name of this file. If both :data and :file are specified, the image is created from what is specified in :data and the string in :file becomes the value of the `image-instance-file-name' function when applied to the resulting image-instance.) :mask-data (Only for XBM images. This specifies a mask to be used with the bitmap. The format is a cons of width, height, and bits, like for :data.) :mask-file (Only for XBM images. This specifies a file containing the mask data.) :color-symbols (Only for XPM images. This specifies an alist that maps strings that specify symbolic color names to the actual color to be used for that symbolic color (in the form of a string or a color-specifier object). If this is not specified, the contents of `xpm-color-symbols' are used to generate the alist.) If instead of a vector, the instantiator is a string, it will be looked up according to the specs in the `device-type-image-conversion-list' (q.v.) for the device type of the domain over which the image is being instantiated. If the instantiator is a string, it will be read in at the time that the instantiator is added to the image, and the instantiator will be converted into one of the [FILENAME ...] forms. This implies that the file must exist when the instantiator is added to the image, but does not need to exist at any other time (e.g. it may be a temporary file). arguments: (OBJECT) Fvalid-glyph-type-p Given an GLYPH-TYPE, return non-nil if it is valid. Valid types are some subset of 'nothing, 'text, 'mono-pixmap, 'color-pixmap, 'cursor, and 'subwindow, depending on how XEmacs was compiled. arguments: (GLYPH-TYPE) Fglyph-type-list Return a list of valid glyph types. arguments: () Fmake-glyph-internal Create a new, uninitialized glyph. arguments: (&optional TYPE) Fglyphp Return non-nil if OBJECT is a glyph. A glyph is an object used for pixmaps and the like. It is used in begin-glyphs and end-glyphs attached to extents, in marginal and textual annotations, in overlay arrows (overlay-arrow-* variables), in toolbar buttons, and the like. Its image is described using an image specifier -- see `image-specifier-p'. arguments: (OBJECT) Fglyph-type Return the type of the given glyph. The return value will be one of 'buffer, 'cursor, or 'icon. arguments: (GLYPH) Fglyph-width Return the width of GLYPH on WINDOW. This may not be exact as it does not take into account all of the context that redisplay will. arguments: (GLYPH &optional WINDOW) Fglyph-ascent Return the ascent value of GLYPH on WINDOW. This may not be exact as it does not take into account all of the context that redisplay will. arguments: (GLYPH &optional WINDOW) Fglyph-descent Return the descent value of GLYPH on WINDOW. This may not be exact as it does not take into account all of the context that redisplay will. arguments: (GLYPH &optional WINDOW) Fglyph-height Return the height of GLYPH on WINDOW. This may not be exact as it does not take into account all of the context that redisplay will. arguments: (GLYPH &optional WINDOW) Voctal-escape-glyph What to prefix character codes displayed in octal with.Vcontrol-arrow-glyph What to use as an arrow for control characters.Vinvisible-text-glyph What to use to indicate the presence of invisible text.Vhscroll-glyph What to display at the beginning of horizontally scrolled lines.Vcurrent-display-table *The display table currently in use. This is a specifier; use `set-specifier' to change it. The display table is a vector created with `make-display-table'. The 256 elements control how to display each possible text character. Each value should be a string, a glyph, a vector or nil. If a value is a vector it must be composed only of strings and glyphs. nil means display the character in the default fashion. Faces can have their own, overriding display table.Vtruncation-glyph What to display at the end of truncated lines.Vcontinuation-glyph What to display at the end of wrapped lines.Vxemacs-logo The glyph used to display the XEmacs logo at startup.Fmake-color-instance Creates a new `color-instance' object of the specified color. DEVICE specifies the device this object applies to and defaults to the selected device. An error is signalled if the color is unknown or cannot be allocated; however, if NOERROR is non-nil, nil is simply returned in this case. The returned object is a normal, first-class lisp object. The way you `deallocate' the color is the way you deallocate any other lisp object: you drop all pointers to it and allow it to be garbage collected. When these objects are GCed, the underlying window-system data (e.g. X object) is deallocated as well. arguments: (NAME &optional DEVICE NO-ERROR) Fcolor-instance-p Return non-nil if OBJECT is a color instance. arguments: (OBJECT) Fcolor-instance-name Return the name used to allocate COLOR-INSTANCE. arguments: (COLOR-INSTANCE) Fcolor-instance-rgb-components Return a three element list containing the red, green, and blue color components of COLOR-INSTANCE, or nil if unknown. arguments: (COLOR-INSTANCE) Fvalid-color-name-p Return true if COLOR names a valid color for the current device. Valid color names for X are listed in the file /usr/lib/X11/rgb.txt, or whatever the equivalent is on your system. Valid color names for TTY are those which have an ISO 6429 (ANSI) sequence. In addition to being a color this may be one of a number of attributes such as `blink'. arguments: (COLOR &optional DEVICE) Fmake-font-instance Creates a new `font-instance' object of the specified name. DEVICE specifies the device this object applies to and defaults to the selected device. An error is signalled if the font is unknown or cannot be allocated; however, if NOERROR is non-nil, nil is simply returned in this case. The returned object is a normal, first-class lisp object. The way you `deallocate' the font is the way you deallocate any other lisp object: you drop all pointers to it and allow it to be garbage collected. When these objects are GCed, the underlying X data is deallocated as well. arguments: (NAME &optional DEVICE NO-ERROR) Ffont-instance-p Return non-nil if OBJECT is a font instance. arguments: (OBJECT) Ffont-instance-name Return the name used to allocate FONT-INSTANCE. arguments: (FONT-INSTANCE) Ffont-instance-truename Return the canonical name of the given font instance. Font names are patterns which may match any number of fonts, of which the first found is used. This returns an unambiguous name for that font (but not necessarily its only unambiguous name). arguments: (FONT-INSTANCE) Ffont-instance-properties Return the properties (an alist or nil) of FONT-INSTANCE. arguments: (FONT-INSTANCE) Flist-fonts Return a list of font names matching the given pattern. DEVICE specifies which device to search for names, and defaults to the currently selected device. arguments: (PATTERN &optional DEVICE) Fcolor-specifier-p Return non-nil if OBJECT is a color specifier. arguments: (OBJECT) Ffont-specifier-p Return non-nil if OBJECT is a font specifier. arguments: (OBJECT) Fface-boolean-specifier-p Return non-nil if OBJECT is a face-boolean specifier. arguments: (OBJECT) Fset-menubar-dirty-flag Tell XEmacs that the menubar has to be updated. arguments: () Vcurrent-menubar The current menubar. This may be buffer-local. When the menubar is changed, the function `set-menubar-dirty-flag' has to be called for the menubar to be updated on the frame. See `set-menubar' and `set-buffer-menubar'. A menubar is a list of menus and menu-items. A menu is a list of menu items, keyword-value pairs, strings, and submenus. The first element of a menu must be a string, which is the name of the menu. This is the string that will be displayed in the parent menu, if any. For toplevel menus, it is ignored. This string is not displayed in the menu itself. Immediately following the name string of the menu, any of three optional keyword-value pairs is permitted. If an element of a menu (or menubar) is a string, then that string will be presented as unselectable text. If an element of a menu is a string consisting solely of hyphens, then that item will be presented as a solid horizontal line. If an element of a menu is a list, it is treated as a submenu. The name of that submenu (the first element in the list) will be used as the name of the item representing this menu on the parent. If an element of a menubar is `nil', then it is used to represent the division between the set of menubar-items which are flushleft and those which are flushright. Otherwise, the element must be a vector, which describes a menu item. A menu item can have any of the following forms: [ "name" callback <active-p> ] [ "name" callback <active-p> "suffix" ] [ "name" callback :<keyword> <value> :<keyword> <value> ... ] The name is the string to display on the menu; it is filtered through the resource database, so it is possible for resources to override what string is actually displayed. If the `callback' of a menu item is a symbol, then it must name a command. It will be invoked with `call-interactively'. If it is a list, then it is evaluated with `eval'. The possible keywords are this: :active <form> Same as <active-p> in the first two forms: the expression is evaluated just before the menu is displayed, and the menu will be selectable only if the result is non-nil. :suffix "string" Same as "suffix" in the second form: the suffix is appended to the displayed name, providing a convenient way of adding the name of a command's ``argument'' to the menu, like ``Kill Buffer NAME''. :keys "string" Normally, the keyboard equivalents of commands in menus are displayed when the `callback' is a symbol. This can be used to specify keys for more complex menu items. It is passed through `substitute-command-keys' first. :style <style> Specifies what kind of object this menu item is: nil A normal menu item. toggle A toggle button. radio A radio button. button A menubar button. The only difference between toggle and radio buttons is how they are displayed. But for consistency, a toggle button should be used when there is one option whose value can be turned on or off, and radio buttons should be used when there is a set of mutally exclusive options. When using a group of radio buttons, you should arrange for no more than one to be marked as selected at a time. :selected <form> Meaningful only when STYLE is `toggle', `radio' or `button'. This specifies whether the button will be in the selected or unselected state. :included <form> This can be used to control the visibility of a menu or menu item. The form is evaluated and the menu or menu item is only displayed if the result is non-nil. :config <symbol> This is an efficient shorthand for :included (memq symbol menubar-configuration) See the variable `menubar-configuration'. :filter <function> A menu filter can only be used in a menu item list. (i.e.: not in a menu item itself). It is used to sensitize or incrementally create a submenu only when it is selected by the user and not every time the menubar is activated. The filter function is passed the list of menu items in the submenu and must return a list of menu items to be used for the menu. It is called only when the menu is about to be displayed, so other menus may already be displayed. Vile and terrible things will happen if a menu filter function changes the current buffer, window, or frame. It also should not raise, lower, or iconify any frames. Basically, the filter function should have no side-effects. For example: ("File" :filter file-menu-filter ; file-menu-filter is a function that takes ; one argument (a list of menu items) and ; returns a list of menu items [ "Save As..." write-file t ] [ "Revert Buffer" revert-buffer (buffer-modified-p) ] [ "Read Only" toggle-read-only :style toggle :selected buffer-read-only ] ) See x-menubar.el for many more examples. After the menubar is clicked upon, but before any menus are popped up, the functions on the `activate-menubar-hook' are invoked to make top-level changes to the menus and menubar. Note, however, that the use of menu filters (using the :filter keyword) is usually a more efficient way to dynamically alter or sensitize menus.Vactivate-menubar-hook Function or functions called before a menubar menu is pulled down. These functions are called with no arguments, and should interrogate and modify the value of `current-menubar' as desired. The functions on this hook are invoked after the mouse goes down, but before the menu is mapped, and may be used to activate, deactivate, add, or delete items from the menus. However, it is probably the case that using a :filter keyword in a submenu would be a more efficient way of updating menus. See the documentation of `current-menubar'. These functions may return the symbol `t' to assert that they have made no changes to the menubar. If any other value is returned, the menubar is recomputed. If `t' is returned but the menubar has been changed, then the changes may not show up right away. Returning `nil' when the menubar has not changed is not so bad; more computation will be done, but redisplay of the menubar will still be performed optimally.Vmenu-no-selection-hook Function or functions to call when a menu or dialog box is dismissed without a selection having been made.Vmenubar-show-keybindings If true, the menubar will display keyboard equivalents. If false, only the command names will be displayed.Vmenubar-configuration A list of symbols, against which the value of the :config tag for each menubar item will be compared. If a menubar item has a :config tag, then it is omitted from the menubar if that tag is not a member of the `menubar-configuration' list.Vmenubar-visible-p *Whether the menubar is visible. This is a specifier; use `set-specifier' to change it.Fscrollbar-line-up Function called when the line-up arrow on the scrollbar is clicked. This is the little arrow at the top of the scrollbar. One argument, the scrollbar's window. You can advise this function to change the scrollbar behavior. arguments: (WINDOW) Fscrollbar-line-down Function called when the line-down arrow on the scrollbar is clicked. This is the little arrow at the bottom of the scrollbar. One argument, the scrollbar's window. You can advise this function to change the scrollbar behavior. arguments: (WINDOW) Fscrollbar-page-up Function called when the user gives the "page-up" scrollbar action. (The way this is done can vary from scrollbar to scrollbar.) One argument, a cons containing the scrollbar's window and a value (#### document me! This value is nil for Motif/Lucid scrollbars and a number for Athena scrollbars). You can advise this function to change the scrollbar behavior. arguments: (OBJECT) Fscrollbar-page-down Function called when the user gives the "page-down" scrollbar action. (The way this is done can vary from scrollbar to scrollbar.) One argument, a cons containing the scrollbar's window and a value (#### document me! This value is nil for Motif/Lucid scrollbars and a number for Athena scrollbars). You can advise this function to change the scrollbar behavior. arguments: (OBJECT) Fscrollbar-to-top Function called when the user gives the "to-top" scrollbar action. (The way this is done can vary from scrollbar to scrollbar.). One argument, the scrollbar's window. You can advise this function to change the scrollbar behavior. arguments: (WINDOW) Fscrollbar-to-bottom Function called when the user gives the "to-bottom" scrollbar action. (The way this is done can vary from scrollbar to scrollbar.). One argument, the scrollbar's window. You can advise this function to change the scrollbar behavior. arguments: (WINDOW) Fscrollbar-vertical-drag Function called when the user drags the vertical scrollbar thumb. One argument, a cons containing the scrollbar's window and a value (#### document me!). You can advise this function to change the scrollbar behavior. arguments: (OBJECT) Fscrollbar-set-hscroll Sets WINDOW's hscroll position to VALUE. This ensures that VALUE is in the proper range for the horizontal scrollbar. arguments: (WINDOW VALUE) Vscrollbar-width *Width of vertical scrollbars. This is a specifier; use `set-specifier' to change it.Vscrollbar-height *Width of vertical scrollbars. This is a specifier; use `set-specifier' to change it.Ftoolbar-button-p Return non-nil if OBJECT is a toolbar button. arguments: (OBJECT) Ftoolbar-button-callback Return the callback function associated with the toolbar BUTTON. arguments: (BUTTON) Ftoolbar-button-help-string Return the help string function associated with the toolbar BUTTON. arguments: (BUTTON) Ftoolbar-button-enabled-p Return t if BUTTON is active. arguments: (BUTTON) Fset-toolbar-button-down-flag Don't touch. arguments: (BUTTON FLAG) Fset-default-toolbar-position Set the position that the `default-toolbar' will be displayed at. Valid positions are 'top, 'bottom, 'left and 'right. See `default-toolbar-position'. arguments: (POSITION) Fdefault-toolbar-position Return the position that the `default-toolbar' will be displayed at. The `default-toolbar' will only be displayed here if the corresponding position-specific toolbar specifier does not provide a value. arguments: () Fcheck-toolbar-button-syntax Verify the syntax of entry BUTTON in a toolbar description list. If you want to verify the syntax of a toolbar description list as a whole, use `check-valid-instantiator' with a specifier type of 'toolbar. arguments: (BUTTON &optional NO-ERROR) Ftoolbar-specifier-p Return non-nil if OBJECT is an toolbar specifier. Toolbar specifiers are used to specify the format of a toolbar. The values of the variables `default-toolbar', `top-toolbar', `left-toolbar', `right-toolbar', and `bottom-toolbar' are always toolbar specifiers. See `default-toolbar' for a description of a valid toolbar instantiator. arguments: (OBJECT) Vdefault-toolbar Specifier for a fallback toolbar. Use `set-specifier' to change this. The position of this toolbar is specified in the function `default-toolbar-position'. If the corresponding position- specific toolbar (e.g. `top-toolbar' if `default-toolbar-position' is 'top) does not specify a toolbar in a particular domain, then the value of `default-toolbar' in that domain, if any, will be used instead. Note that the toolbar at any particular position will not be displayed unless its thickness (width or height, depending on orientation) is non-zero. The thickness is controlled by the variables `top-toolbar-height', `bottom-toolbar-height', `left-toolbar-width', and `right-toolbar-width'. By default, only `top-toolbar-height' has a non-zero value. The format of the instantiator for a toolbar is a list of toolbar-button-descriptors. Each toolbar-button-descriptor is a vector in one of the following formats: [GLYPH-LIST FUNCTION ENABLED-P HELP] or [:style 2D-OR-3D] or [:style 2D-OR-3D :size WIDTH-OR-HEIGHT] or [:size WIDTH-OR-HEIGHT :style 2D-OR-3D] Optionally, one of the toolbar-button-descriptors may be nil instead of a vector; this signifies the division between the toolbar buttons that are to be displayed flush-left, and the buttons to be displayed flush-right. The first vector format above specifies a normal toolbar button; the others specify blank areas in the toolbar. For the first vector format: -- GLYPH-LIST should be a list of one to six glyphs (as created by `make-glyph') or a symbol whose value is such a list. The first glyph, which must be provided, is the glyph used to display the toolbar button when it is in the "up" (not pressed) state. The optional second glyph is for displaying the button when it is in the "down" (pressed) state. The optional third glyph is for when the button is disabled. The optional fourth, fifth and sixth glyphs are used to specify captioned versions for the up, down and disabled states respectively. The function `toolbar-make-button-list' is useful in creating these glyph lists. The specifier variable `toolbar-use-captions' controls whic glyphs are actually used. Even if you do not provide separate down-state and disabled-state glyphs, the user will still get visual feedback to indicate which state the button is in. Buttons in the up-state are displayed with a shadowed border that gives a raised appearance to the button. Buttons in the down-state are displayed with shadows that give a recessed appearance. Buttons in the disabled state and displayed with no shadows, giving a 2-d effect. -- The second element FUNCTION is a function to be called when the toolbar button is activated (i.e. when the mouse is released over the toolbar button, if the press occurred in the toolbar). It can be any form accepted by `call-interactively', since this is how it is invoked. -- The third element ENABLED-P specifies whether the toolbar button is enabled (disabled buttons do nothing when they are activated, and are displayed differently; see above). It should be either a boolean or a form that evaluates to a boolean. -- The fourth element HELP, if non-nil, should be a string. This string is displayed in the echo area when the mouse passes over the toolbar button. For the other vector formats (specifying blank areas of the toolbar): -- 2D-OR-3D should be one of the symbols '2d or '3d, indicating whether the area is displayed with shadows (giving it a raised, 3-d appearance) or without shadows (giving it a flat appearance). -- WIDTH-OR-HEIGHT specifies the length, in pixels, of the blank area. If omitted, it defaults to a device-specific value (8 pixels for X devices).Vtop-toolbar Specifier for toolbar at the top of the frame. Use `set-specifier' to change this. See `default-toolbar' for a description of a valid toolbar instantiator.Vbottom-toolbar Specifier for toolbar at the bottom of the frame. Use `set-specifier' to change this. See `default-toolbar' for a description of a valid toolbar instantiator. Note that by default the height of the bottom toolbar (controlled by `bottom-toolbar-height') is 0; thus, a bottom toolbar will not be displayed even if you provide a value for `bottom-toolbar'.Vleft-toolbar Specifier for toolbar at the left edge of the frame. Use `set-specifier' to change this. See `default-toolbar' for a description of a valid toolbar instantiator. Note that by default the width of the left toolbar (controlled by `left-toolbar-width') is 0; thus, a left toolbar will not be displayed even if you provide a value for `left-toolbar'.Vright-toolbar Specifier for toolbar at the right edge of the frame. Use `set-specifier' to change this. See `default-toolbar' for a description of a valid toolbar instantiator. Note that by default the width of the right toolbar (controlled by `right-toolbar-width') is 0; thus, a right toolbar will not be displayed even if you provide a value for `right-toolbar'.Vtop-toolbar-height *Height of top toolbar. This is a specifier; use `set-specifier' to change it.Vbottom-toolbar-height *Height of bottom toolbar. This is a specifier; use `set-specifier' to change it.Vleft-toolbar-width *Width of left toolbar. This is a specifier; use `set-specifier' to change it.Vright-toolbar-width *Width of right toolbar. This is a specifier; use `set-specifier' to change it.Vtoolbar-buttons-captioned-p *Whether the toolbar buttons are captioned. This will only have a visible effect for those toolbar buttons which had captioned versions specified. This is a specifier; use `set-specifier' to change it.Fmd5 Return the MD5 (a secure message digest algorithm) of an object. OBJECT is either a string or a buffer. Optional arguments START and END denote buffer positions for computing the hash of a portion of OBJECT. arguments: (OBJECT &optional START END) Fmmap-allocator-status Return some information about mmap-based allocator. mmap-addrlist-size: number of entries in address picking list. mmap-times-mapped: number of times r_alloc was called. mmap-pages-mapped: number of pages mapped by r_alloc calls only. mmap-times-unmapped: number of times r_free was called. mmap-times-remapped: number of times r_re_alloc was called. mmap-didnt-copy: number of times re-alloc didn't have to move the block. mmap-pages-copied: total number of pages copied. mmap-average-bumpval: average increase in size demanded to re-alloc. mmap-wastage: total number of bytes allocated, but not currently in use. mmap-live-pages: total number of pages live. arguments: () Vmmap-hysteresis Extra room left at the end of an allocated arena, so that a re-alloc requesting extra space smaller than this does not actually cause a new arena to be allocated. A negative value is considered equal to zero. This is the minimum amount of space guaranteed to be left at the end of the arena. Because allocation happens in multiples of the OS page size, it is possible for more space to be left unused. Vemacs-version Version numbers of this version of Emacs. Vemacs-build-time Time at which Emacs was dumped out. Femacs-version Return string describing the version of Emacs that is running. Flambda Return a lambda expression. A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is self-quoting; the result of evaluating the lambda expression is the expression itself. The lambda expression may then be treated as a function, i. e. stored as the function value of a symbol, passed to funcall or mapcar, etcetera. ARGS should take the same form as an argument list for a `defun'. DOCSTRING should be a string, as described for `defun'. It may be omitted. INTERACTIVE should be a call to the function `interactive', which see. It may also be omitted. BODY should be a list of lisp expressions. Frun-hooks Takes hook names and runs each one in turn. Major mode functions use this. Each argument should be a symbol, a hook variable. These symbols are processed in the order specified. If a hook symbol has a non-nil value, that value may be a function or a list of functions to be called to run the hook. If the value is a function, it is called with no arguments. If it is a list, the elements are called, in order, with no arguments. Frun-hook-with-args Run HOOK with the specified arguments ARGS. HOOK should be a symbol, a hook variable. If HOOK has a non-nil value, that value may be a function or a list of functions to be called to run the hook. If the value is a function, it is called with the given arguments and its return value is returned. If it is a list, the elements are called, in order, with the given arguments, and a list of the each function's return value is returned. Frun-special-hook-with-args Run HOOK with the specified arguments, returning the first non-nil value. HOOK should be a symbol, a hook variable. If HOOK has a non-nil value, that value may be a function or a list of functions to be called to run the hook. If the value is a function, it is called with the given arguments and its return value is returned. If it is a list, the elements are called, in order, with the given arguments, until one of them returns non-nil, and this value is returned. Fadd-hook Add to the value of HOOK the function FUNCTION. FUNCTION is not added if already present. FUNCTION is added (if necessary) at the beginning of the hook list unless the optional argument APPEND is non-nil, in which case FUNCTION is added at the end. HOOK should be a symbol, and FUNCTION may be any valid function. If HOOK is void, it is first set to nil. If HOOK's value is a single function, it is changed to a list of functions. Fremove-hook Remove from the value of HOOK the function FUNCTION. HOOK should be a symbol, and FUNCTION may be any valid function. If FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the list of hooks to run in HOOK, then nothing is done. See `add-hook'. Vkill-buffer-hook Function or functions to be called when a buffer is killed. The value of this variable may be buffer-local. The buffer about to be killed is current when this hook is run. Vkill-emacs-hook Function or functions to be called when `kill-emacs' is called, just before emacs is actually killed. Fsecond Return the second element of the list LIST. Fthird Return the third element of the list LIST. Ffourth Return the fourth element of the list LIST. Ffifth Return the fifth element of the list LIST. Fsixth Return the sixth element of the list LIST. Fseventh Return the seventh element of the list LIST. Feighth Return the eighth element of the list LIST. Fninth Return the ninth element of the list LIST. Ftenth Return the tenth element of the list LIST. Fcaar Return the `car' of the `car' of X. Fcadr Return the `car' of the `cdr' of X. Fcdar Return the `cdr' of the `car' of X. Fcddr Return the `cdr' of the `cdr' of X. Fcaaar Return the `car' of the `car' of the `car' of X. Fcaadr Return the `car' of the `car' of the `cdr' of X. Fcadar Return the `car' of the `cdr' of the `car' of X. Fcaddr Return the `car' of the `cdr' of the `cdr' of X. Fcdaar Return the `cdr' of the `car' of the `car' of X. Fcdadr Return the `cdr' of the `car' of the `cdr' of X. Fcddar Return the `cdr' of the `cdr' of the `car' of X. Fcdddr Return the `cdr' of the `cdr' of the `cdr' of X. Fcaaaar Return the `car' of the `car' of the `car' of the `car' of X. Fcaaadr Return the `car' of the `car' of the `car' of the `cdr' of X. Fcaadar Return the `car' of the `car' of the `cdr' of the `car' of X. Fcaaddr Return the `car' of the `car' of the `cdr' of the `cdr' of X. Fcadaar Return the `car' of the `cdr' of the `car' of the `car' of X. Fcadadr Return the `car' of the `cdr' of the `car' of the `cdr' of X. Fcaddar Return the `car' of the `cdr' of the `cdr' of the `car' of X. Fcadddr Return the `car' of the `cdr' of the `cdr' of the `cdr' of X. Fcdaaar Return the `cdr' of the `car' of the `car' of the `car' of X. Fcdaadr Return the `cdr' of the `car' of the `car' of the `cdr' of X. Fcdadar Return the `cdr' of the `car' of the `cdr' of the `car' of X. Fcdaddr Return the `cdr' of the `car' of the `cdr' of the `cdr' of X. Fcddaar Return the `cdr' of the `cdr' of the `car' of the `car' of X. Fcddadr Return the `cdr' of the `cdr' of the `car' of the `cdr' of X. Fcdddar Return the `cdr' of the `cdr' of the `cdr' of the `car' of X. Fcddddr Return the `cdr' of the `cdr' of the `cdr' of the `cdr' of X. Flast Returns the last link in the list LIST. With optional argument N, returns Nth-to-last link (default 1). Fbutlast Returns a copy of LIST with the last N elements removed. Fnbutlast Modifies LIST to remove the last N elements. Fpush Insert VAL at the head of LIST. Analogous to (setq LIST (cons VAL LIST)). Fpop Remove and return the head of LIST. Analogous to (prog1 (car LIST) (setq LIST (cdr LIST))). Fsome Return true if PREDICATE is true of any element of SEQ. If so, return the true (non-nil) value returned by PREDICATE. Fevery Return true if PREDICATE is true of every element of SEQ. Fnotany Return true if PREDICATE is false of every element of SEQ. Fnotevery Return true if PREDICATE is false of some element of SEQ. Fmapvector Apply FUNCTION to each element of SEQ, making a vector of the results. The result is a vector of the same length as SEQ. SEQ may be a list, a vector or a string. Fadjoin Add ITEM to LIST (unless it's already there) and return the new list. Funion Return a list of elements that appear in either LIST1 or LIST2. Fintersection Return a list of elements that appear in both LIST1 and LIST2. Fset-difference Return a list of elements of LIST1 that do not appear in LIST2. Fset-exclusive-or Return a list of elements that appear in exactly one of LIST1 and LIST2. Fsubsetp True if every element of LIST1 also appears in LIST2. Freplace-in-string Replaces all matches in STR for REGEXP with NEWTEXT string. Optional LITERAL non-nil means do a literal replacement. Otherwise treat \ in NEWTEXT string as special: \& means substitute original matched text, \N means substitute match for (...) number N, \\ means insert one \. Fsplit-string Return a list of substrings of STRING which are separated by PATTERN. Fwith-output-to-string Collect output to `standard-output' while evaluating FORMS and return it as a string. Finsert-face Insert STRING and highlight with FACE. Returns the extent created. Fignore Do nothing and return nil. This function accepts any number of arguments, but ignores them. Ferror Signal an error, making error message by passing all args to `format'. This error is not continuable: you cannot continue execution after the error using the debugger `r' command. See also `cerror'. Fcerror Like `error' but signals a continuable error. Fcheck-argument-type Check that ARGUMENT satisfies PREDICATE. If not, signal a continuable `wrong-type-argument' error until the returned value satifies PREDICATE, and assign the returned value to ARGUMENT. Fsave-current-buffer Restore the current buffer setting after executing FORMS. Does not restore the values of point and mark. See also: `save-excursion'. Feval-in-buffer Evaluate FORMS in BUFFER. See also: `save-current-buffer' and `save-excursion'. Ffunctionp Returns t if OBJ is a function, nil otherwise. Fadd-to-list Add to the value of LIST-VAR the element ELEMENT if it isn't there yet. If you want to use `add-to-list' on a variable that is not defined until a certain package is loaded, you should put the call to `add-to-list' into a hook function that will be run only after loading the package. Major mode hooks are one thing which can do the job. Frecursion-depth Return the current depth in recursive edits. Ftop-level Exit all recursive editing levels. Fexit-recursive-edit Exit from the innermost recursive edit or minibuffer. Fabort-recursive-edit Abort the command that requested this recursive edit or minibuffer input. Fkeyboard-quit Signal a `quit' condition. If this character is typed while lisp code is executing, it will be treated as an interrupt. If this character is typed at top-level, this simply beeps. If `zmacs-regions' is true, and the zmacs region is active, then this key deactivates the region without beeping or signalling. Vlast-error #### Document me. Fdescribe-last-error Redisplay the last error-message. See the variable `last-error'. Fdisplay-error Display `error-object' on `stream' in a user-friendly way. Vteach-extended-commands-p *If true, then `\[execute-extended-command]' will teach you keybindings. Any time you execute a command with \[execute-extended-command] which has a shorter keybinding, you will be shown the alternate binding before the command executes. Vteach-extended-commands-timeout *How long to pause after displaying a keybinding before executing. This only applies if `teach-extended-commands-p' is true. Fexecute-extended-command Read a command name from the minibuffer using 'completing-read'. Then call the specified command using 'command-execute' and return its return value. If the command asks for a prefix argument, supply the value of the current raw prefix argument, or the value of PREFIX-ARG when called from Lisp. Fy-or-n-p-minibuf Ask user a "y or n" question. Return t if answer is "y". Takes one argument, which is the string to display to ask the question. It should end in a space; `y-or-n-p' adds `(y or n) ' to it. No confirmation of the answer is requested; a single character is enough. Also accepts Space to mean yes, or Delete to mean no. Fyes-or-no-p-minibuf Ask user a yes-or-no question. Return t if answer is yes. Takes one argument, which is the string to display to ask the question. It should end in a space; `yes-or-no-p' adds `(yes or no) ' to it. The user must confirm the answer with RET, and can edit it until it has been confirmed. Fread-char Read a character from the command input (keyboard or macro). If a mouse click or non-ASCII character is detected, an error is signalled. The character typed is returned as an ASCII value. This is most likely the wrong thing for you to be using: consider using the `next-command-event' function instead. Fread-char-exclusive Read a character from the command input (keyboard or macro). If a mouse click or non-ASCII character is detected, it is discarded. The character typed is returned as an ASCII value. This is most likely the wrong thing for you to be using: consider using the `next-command-event' function instead. Fread-quoted-char Like `read-char', except that if the first character read is an octal digit, we read up to two more octal digits and return the character represented by the octal number consisting of those digits. Optional argument PROMPT specifies a string to use to prompt the user. Fmomentary-string-display Momentarily display STRING in the buffer at POS. Display remains until next character is typed. If the char is EXIT-CHAR (optional third arg, default is SPC) it is swallowed; otherwise it is then available as input (as a command if nothing else). Display MESSAGE (optional fourth arg) in the echo area. If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there. Vminor-mode-map-alist Alist of keymaps to use for minor modes. Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read key sequences and look up bindings iff VARIABLE's value is non-nil. If two active keymaps bind the same key, the keymap appearing earlier in the list takes precedence. Vmodeline-map Keymap consulted for mouse-clicks on the modeline of a window. This variable may be buffer-local; its value will be looked up in the buffer of the window whose modeline was clicked upon. Vtoolbar-map Keymap consulted for mouse-clicks over a toolbar. Fsuppress-keymap Make MAP override all normally self-inserting keys to be undefined. Normally, as an exception, digits and minus-sign are set to make prefix args, but optional second arg NODIGITS non-nil treats them like other chars. Fsubstitute-key-definition Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF. In other words, OLDDEF is replaced with NEWDEF wherever it appears. Prefix keymaps are checked recursively. If optional fourth argument OLDMAP is specified, we redefine in KEYMAP as NEWDEF those chars which are defined as OLDDEF in OLDMAP, unless that keybinding is already present in keymap. If optional fifth argument PREFIX is defined, then only those occurrences of OLDDEF found in keymaps accessible through the keymap bound to PREFIX in KEYMAP are redefined. See also `accessible-keymaps'. Fread-command-or-command-sexp Read a command symbol or command sexp. A command sexp is wrapped in an interactive lambda if needed. Prompts with PROMPT. Flocal-key-binding Return the binding for command KEYS in current local keymap only. KEYS is a string, a vector of events, or a vector of key-description lists as described in the documentation for the `define-key' function. The binding is probably a symbol with a function definition; see the documentation for `lookup-key' for more information. Fglobal-key-binding Return the binding for command KEYS in current global keymap only. KEYS is a string or vector of events, a sequence of keystrokes. The binding is probably a symbol with a function definition; see the documentation for `lookup-key' for more information. Fglobal-set-key Give KEY a global binding as COMMAND. COMMAND is a symbol naming an interactively-callable function. KEYS is a string, a vector of events, or a vector of key-description lists as described in the documentation for the `define-key' function. Note that if KEY has a local binding in the current buffer that local binding will continue to shadow any global binding. Flocal-set-key Give KEY a local binding as COMMAND. COMMAND is a symbol naming an interactively-callable function. KEYS is a string, a vector of events, or a vector of key-description lists as described in the documentation for the `define-key' function. The binding goes in the current buffer's local map, which is shared with other buffers in the same major mode. Fglobal-unset-key Remove global binding of KEY. KEYS is a string, a vector of events, or a vector of key-description lists as described in the documentation for the `define-key' function. Flocal-unset-key Remove local binding of KEY. KEYS is a string, a vector of events, or a vector of key-description lists as described in the documentation for the `define-key' function. Fminor-mode-key-binding Find the visible minor mode bindings of KEY. Return an alist of pairs (MODENAME . BINDING), where MODENAME is the the symbol which names the minor mode binding KEY, and BINDING is KEY's definition in that mode. In particular, if KEY has no minor-mode bindings, return nil. If the first binding is a non-prefix, all subsequent bindings will be omitted, since they would be ignored. Similarly, the list doesn't include non-prefix bindings that come after prefix bindings. If optional argument ACCEPT-DEFAULT is non-nil, recognize default bindings; see the description of `lookup-key' for more details about this. Fcurrent-minor-mode-maps Return a list of keymaps for the minor modes of the current buffer. Fdefine-prefix-command Define COMMAND as a prefix command. A new sparse keymap is stored as COMMAND's function definition. If second optional argument MAPVAR is not specified, COMMAND's value (as well as its function definition) is set to the keymap. If a second optional argument MAPVAR is given and is not `t', the map is stored as its value. Regardless of MAPVAR, COMMAND's function-value is always set to the keymap. Fevents-to-keys Given a vector of event objects, returns a vector of key descriptors, or a string (if they all fit in the ASCII range). Optional arg NO-MICE means that button events are not allowed. Fmake-syntax-table Return a new syntax table. It inherits all letters and control characters from the standard syntax table; other characters are copied from the standard syntax table. Fmodify-syntax-entry Set syntax for character CHAR according to string S. The syntax is changed only for table TABLE, which defaults to the current buffer's syntax table. The first character of S should be one of the following: Space whitespace syntax. w word constituent. _ symbol constituent. . punctuation. ( open-parenthesis. ) close-parenthesis. " string quote. \ character-quote. $ paired delimiter. ' expression quote or prefix operator. < comment starter. > comment ender. / character-quote. @ inherit from `standard-syntax-table'. Only single-character comment start and end sequences are represented thus. Two-character sequences are represented as described below. The second character of S is the matching parenthesis, used only if the first character is `(' or `)'. Any additional characters are flags. Defined flags are the characters 1, 2, 3, 4, 5, 6, 7, 8, p, a, and b. 1 means C is the first of a two-char comment start sequence of style a. 2 means C is the second character of such a sequence. 3 means C is the first of a two-char comment end sequence of style a. 4 means C is the second character of such a sequence. 5 means C is the first of a two-char comment start sequence of style b. 6 means C is the second character of such a sequence. 7 means C is the first of a two-char comment end sequence of style b. 8 means C is the second character of such a sequence. p means C is a prefix character for `backward-prefix-chars'; such characters are treated as whitespace when they occur between expressions. a means C is comment starter or comment ender for comment style a (default) b means C is comment starter or comment ender for comment style b. Fsymbol-near-point Return the first textual item to the nearest point. Vinsert-default-directory *Non-nil means when reading a filename start with default dir in minibuffer. Vminibuffer-completion-table Alist or obarray used for completion in the minibuffer. This becomes the ALIST argument to `try-completion' and `all-completions'. The value may alternatively be a function, which is given three arguments: STRING, the current buffer contents; PREDICATE, the predicate for filtering possible matches; CODE, which says what kind of things to do. CODE can be nil, t or `lambda'. nil means to return the best completion of STRING, nil if there is none, or t if it is was already a unique completion. t means to return a list of all possible completions of STRING. `lambda' means to return t if STRING is a valid completion as it stands. Vminibuffer-completion-predicate Within call to `completing-read', this holds the PREDICATE argument. Vminibuffer-completion-confirm Non-nil => demand confirmation of completion before exiting minibuffer. Vminibuffer-confirm-incomplete If true, then in contexts where completing-read allows answers which are not valid completions, an extra RET must be typed to confirm the response. This is helpful for catching typos, etc. Vcompletion-auto-help *Non-nil means automatically provide help for invalid completion input. Venable-recursive-minibuffers *Non-nil means to allow minibuffer commands while in the minibuffer. More precisely, this variable makes a difference when the minibuffer window is the selected window. If you are in some other window, minibuffer commands are allowed even if a minibuffer is active. Vminibuffer-max-depth *Global maximum number of minibuffers allowed; compare to enable-recursive-minibuffers, which is only consulted when the minibuffer is reinvoked while it is the selected window. Vminibuffer-exit-hook Normal hook run just after exit from minibuffer. Vminibuffer-help-form Value that `help-form' takes on inside the minibuffer. Vminibuffer-local-map Default keymap to use when reading from the minibuffer. Vminibuffer-local-completion-map Local keymap for minibuffer input with completion. Vminibuffer-local-must-match-map Local keymap for minibuffer input with completion, for exact match. Vread-expression-map Minibuffer keymap used for reading Lisp expressions. Vread-shell-command-map Minibuffer keymap used by shell-command and related commands. Fminibuffer-keyboard-quit Abort recursive edit. If `zmacs-regions' is true, and the zmacs region is active, then this key deactivates the region without beeping. Fminibuffer-window-active-p Return t if WINDOW (a minibuffer window) is now active. Vminibuffer-history-variable History list symbol to add minibuffer values to. Each minibuffer output is added with (set minibuffer-history-variable (cons STRING (symbol-value minibuffer-history-variable))) Vminibuffer-history-minimum-string-length If this variable is non-nil, a string will not be added to the minibuffer history if its length is less than that value. Fread-from-minibuffer Read a string from the minibuffer, prompting with string PROMPT. If optional second arg INITIAL-CONTENTS is non-nil, it is a string to be inserted into the minibuffer before reading input. If INITIAL-CONTENTS is (STRING . POSITION), the initial input is STRING, but point is placed POSITION characters into the string. Third arg KEYMAP is a keymap to use whilst reading; if omitted or nil, the default is `minibuffer-local-map'. If fourth arg READ is non-nil, then interpret the result as a lisp object and return that object: in other words, do `(car (read-from-string INPUT-STRING))' Fifth arg HISTORY, if non-nil, specifies a history list and optionally the initial position in the list. It can be a symbol, which is the history list variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In that case, HISTVAR is the history list variable to use, and HISTPOS is the initial position (the position in the list which INITIAL-CONTENTS corresponds to). If HISTORY is `t', no history will be recorded. Positions are counted starting from 1 at the beginning of the list. Sixth arg ABBREV-TABLE, if non-nil, becomes the value of `local-abbrev-table' in the minibuffer. See also the variable completion-highlight-first-word-only for control over completion display Fcompleting-read Read a string in the minibuffer, with completion. Args: PROMPT, TABLE, PREDICATE, REQUIRE-MATCH, INITIAL-CONTENTS, HISTORY. PROMPT is a string to prompt with; normally it ends in a colon and a space. TABLE is an alist whose elements' cars are strings, or an obarray. PREDICATE limits completion to a subset of TABLE. See `try-completion' for more details on completion, TABLE, and PREDICATE. If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless the input is (or completes to) an element of TABLE or is null. If it is also not t, Return does not exit if it does non-null completion. If INITIAL-CONTENTS is non-nil, insert it in the minibuffer initially. If it is (STRING . POSITION), the initial input is STRING, but point is placed POSITION characters into the string. HISTORY, if non-nil, specifies a history list and optionally the initial position in the list. It can be a symbol, which is the history list variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In that case, HISTVAR is the history list variable to use, and HISTPOS is the initial position (the position in the list which INITIAL-CONTENTS corresponds to). If HISTORY is `t', no history will be recorded. Positions are counted starting from 1 at the beginning of the list. Completion ignores case if the ambient value of `completion-ignore-case' is non-nil. Fminibuffer-complete Complete the minibuffer contents as far as possible. Return nil if there is no valid completion, else t. If no characters can be completed, display a list of possible completions. If you repeat this command after it displayed such a list, scroll the window of possible completions. Fminibuffer-complete-and-exit Complete the minibuffer contents, and maybe exit. Exit if the name is valid with no completion needed. If name was completed to a valid match, a repetition of this command will exit. Fself-insert-and-exit Terminate minibuffer input. Fexit-minibuffer Terminate this minibuffer argument. If minibuffer-confirm-incomplete is true, and we are in a completing-read of some kind, and the contents of the minibuffer is not an existing completion, requires an additional RET before the minibuffer will be exited (assuming that RET was the character that invoked this command: the character in question must be typed again). Fminibuffer-complete-word Complete the minibuffer contents at most a single word. After one word is completed as much as possible, a space or hyphen is added, provided that matches some possible completion. Return nil if there is no valid completion, else t. Vcompletion-highlight-first-word-only *Completion will only hightlight the first blank delimited word if t. If the variable in not t or nil, the string is taken as a regexp to match for end of highlight Fdisplay-completion-list Display the list of completions, COMPLETIONS, using `standard-output'. Each element may be just a symbol or string or may be a list of two strings to be printed as if concatenated. Frob a mousable extent onto each completion. This extent has properties 'highlight (so it highlights when the mouse passes over it) and 'completion (so it can be located). If ACTIVATE-CALLBACK is non-nil, it should be a function of two arguments (EXTENT USER-DATA) that will be called when button2 is pressed on the extent. (This is set up using an extent-local keymap; therefore, button2 will have its normal binding if clicked outside of the extent.) At the end, run the normal hook `completion-setup-hook'. It can find the completion buffer in `standard-output'. If `completion-highlight-first-word-only' is non-nil, then only the start of the string is highlighted. Fminibuffer-completion-help Display a list of possible completions of the current minibuffer contents. Vminibuffer-history Default minibuffer history list. This is used for all minibuffer input except when an alternate history list is specified. Vminibuffer-history-sexp-flag Non-nil when doing history operations on `command-history'. More generally, indicates that the history list being acted on contains expressions rather than strings. Fprevious-matching-history-element Find the previous history element that matches REGEXP. (Previous history elements refer to earlier actions.) With prefix argument N, search for Nth previous match. If N is negative, find the next or Nth next match. Fnext-matching-history-element Find the next history element that matches REGEXP. (The next history element refers to a more recent action.) With prefix argument N, search for Nth next match. If N is negative, find the previous or Nth previous match. Fnext-history-element Insert the next element of the minibuffer history into the minibuffer. Fprevious-history-element Inserts the previous element of the minibuffer history into the minibuffer. Fnext-complete-history-element Get next element of history which is a completion of minibuffer contents. Fprevious-complete-history-element Get previous element of history which is a completion of minibuffer contents. Fread-expression Return a Lisp object read using the minibuffer. Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS is a string to insert in the minibuffer before reading. Third arg HISTORY, if non-nil, specifies a history list. Fread-string Return a string from the minibuffer, prompting with string PROMPT. If non-nil, optional second arg INITIAL-CONTENTS is a string to insert in the minibuffer before reading. Third arg HISTORY, if non-nil, specifies a history list. Feval-minibuffer Return value of Lisp expression read using the minibuffer. Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS is a string to insert in the minibuffer before reading. Third arg HISTORY, if non-nil, specifies a history list. Fread-command Read the name of a command and return as a symbol. Prompts with PROMPT. Fread-function Read the name of a function and return as a symbol. Prompts with PROMPT. Fread-variable Read the name of a user variable and return it as a symbol. Prompts with PROMPT. A user variable is one whose documentation starts with a `*' character. Fread-buffer Read the name of a buffer and return as a string. Prompts with PROMPT. Optional second arg DEFAULT is value to return if user enters an empty line. If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed. Fread-number Reads a number from the minibuffer. Fread-shell-command Just like read-string, but uses read-shell-command-map: \{read-shell-command-map} Fread-file-name Read file name, prompting with PROMPT and completing in directory DIR. Value is not expanded---you must call `expand-file-name' yourself. Value is subject to interpreted by substitute-in-file-name however. Default name to DEFAULT if user enters a null string. (If DEFAULT is omitted, the visited file name is used.) Fourth arg MUST-MATCH non-nil means require existing file's name. Non-nil and non-t means also require confirmation after completion. Fifth arg INITIAL-CONTENTS specifies text to start with. Sixth arg HISTORY specifies the history list to use. Default is `file-name-history'. DIR defaults to current buffer's directory default. Fread-directory-name Read directory name, prompting with PROMPT and completing in directory DIR. Value is not expanded---you must call `expand-file-name' yourself. Value is subject to interpreted by substitute-in-file-name however. Default name to DEFAULT if user enters a null string. (If DEFAULT is omitted, the current buffer's default directory is used.) Fourth arg MUST-MATCH non-nil means require existing directory's name. Non-nil and non-t means also require confirmation after completion. Fifth arg INITIAL-CONTENTS specifies text to start with. Sixth arg HISTORY specifies the history list to use. Default is `file-name-history'. DIR defaults to current buffer's directory default. Fappend-expand-filename Append STRING to FILE-STRING differently depending on whether STRING is a username (~string), an environment variable ($string), or a filename (/string). The resultant string is returned with the environment variable or username expanded and resolved to indicate whether it is a file(/result) or a directory (/result/). Fread-face Read the name of a face from the minibuffer and return it as a symbol. Vx-library-search-path Search path used by `read-color' to find rgb.txt. Fread-color Read the name of a color from the minibuffer. Uses `x-library-search-path' to find rgb.txt in order to build a completion table. Fread-coding-system Read a coding-system (or nil) from the minibuffer. Prompting with string PROMPT. Fread-non-nil-coding-system Read a non-nil coding-system from the minibuffer. Prompt with string PROMPT. Vbuilt-in-face-specifiers A list of the built-in face properties that are specifiers. Fface-property Return FACE's value of the given PROPERTY. If LOCALE is omitted, the FACE's actual value for PROPERTY will be returned. For built-in properties, this will be a specifier object of a type appropriate to the property (e.g. a font or color specifier). For other properties, this could be anything. If LOCALE is supplied, then instead of returning the actual value, the specification(s) for the given locale or locale type will be returned. This will only work if the actual value of PROPERTY is a specifier (this will always be the case for built-in properties, but not or not may apply to user-defined properties). If the actual value of PROPERTY is not a specifier, this value will simply be returned regardless of LOCALE. The return value will be a list of instantiators (e.g. strings specifying a font or color name), or a list of specifications, each of which is a cons of a locale and a list of instantiators. Specifically, if LOCALE is a particular locale (a buffer, window, frame, device, or 'global), a list of instantiators for that locale will be returned. Otherwise, if LOCALE is a locale type (one of the symbols 'buffer, 'window, 'frame, or 'device), the specifications for all locales of that type will be returned. Finally, if LOCALE is 'all, the specifications for all locales of all types will be returned. The specifications in a specifier determine what the value of PROPERTY will be in a particular "domain" or set of circumstances, which is typically a particular Emacs window along with the buffer it contains and the frame and device it lies within. The value is derived from the instantiator associated with the most specific locale (in the order buffer, window, frame, device, and 'global) that matches the domain in question. In other words, given a domain (i.e. an Emacs window, usually), the specifier for PROPERTY will first be searched for a specification whose locale is the buffer contained within that window; then for a specification whose locale is the window itself; then for a specification whose locale is the frame that the window is contained within; etc. The first instantiator that is valid for the domain (usually this means that the instantiator is recognized by the device [i.e. the X server or TTY device] that the domain is on. The function `face-property-instance' actually does all this, and is used to determine how to display the face. See `set-face-property' for the built-in property-names. Fconvert-face-property-into-specifier Convert PROPERTY on FACE into a specifier, if it's not already. Fface-property-instance Return the instance of FACE's PROPERTY in the specified DOMAIN. Under most circumstances, DOMAIN will be a particular window, and the returned instance describes how the specified property actually is displayed for that window and the particular buffer in it. Note that this may not be the same as how the property appears when the buffer is displayed in a different window or frame, or how the property appears in the same window if you switch to another buffer in that window; and in those cases, the returned instance would be different. The returned instance will typically be a color-instance, font-instance, or pixmap-instance object, and you can query it using the appropriate object-specific functions. For example, you could use `color-instance-rgb-components' to find out the RGB (red, green, and blue) components of how the 'background property of the 'highlight face is displayed in a particular window. The results might be different from the results you would get for another window (perhaps the user specified a different color for the frame that window is on; or perhaps the same color was specified but the window is on a different X server, and that X server has different RGB values for the color from this one). DOMAIN defaults to the selected window if omitted. DOMAIN can be a frame or device, instead of a window. The value returned for a such a domain is used in special circumstances when a more specific domain does not apply; for example, a frame value might be used for coloring a toolbar, which is conceptually attached to a frame rather than a particular window. The value is also useful in determining what the value would be for a particular window within the frame or device, if it is not overridden by a more specific specification. If PROPERTY does not name a built-in property, its value will simply be returned unless it is a specifier object, in which case it will be instanced using `specifier-instance'. Optional arguments DEFAULT and NO-FALLBACK are the same as in `specifier-instance'. Fset-face-property Change a property of a FACE. NOTE: If you want to remove a property from a face, use `remove-face-property' rather than attempting to set a value of nil for the property. For built-in properties, the actual value of the property is a specifier and you cannot change this; but you can change the specifications within the specifier, and that is what this function will do. For user-defined properties, you can use this function to either change the actual value of the property or, if this value is a specifier, change the specifications within it. If PROPERTY is a built-in property, the specifications to be added to this property can be supplied in many different ways: -- If VALUE is a simple instantiator (e.g. a string naming a font or color) or a list of instantiators, then the instantiator(s) will be added as a specification of the property for the given LOCALE (which defaults to 'global if omitted). -- If VALUE is a list of specifications (each of which is a cons of a locale and a list of instantiators), then LOCALE must be nil (it does not make sense to explicitly specify a locale in this case), and specifications will be added as given. -- If VALUE is a specifier (as would be returned by `face-property' if no LOCALE argument is given), then some or all of the specifications in the specifier will be added to the property. In this case, the function is really equivalent to `copy-specifier' and LOCALE has the same semantics (if it is a particular locale, the specification for the locale will be copied; if a locale type, specifications for all locales of that type will be copied; if nil or 'all, then all specifications will be copied). HOW-TO-ADD should be either nil or one of the symbols 'prepend, 'append, 'remove-tag-set-prepend, 'remove-tag-set-append, 'remove-locale, 'remove-locale-type, or 'remove-all. See `copy-specifier' and `add-spec-to-specifier' for a description of what each of these means. Most of the time, you do not need to worry about this argument; the default behavior usually is fine. In general, it is OK to pass an instance object (e.g. as returned by `face-property-instance') as an instantiator in place of an actual instantiator. In such a case, the instantiator used to create that instance object will be used (for example, if you set a font-instance object as the value of the 'font property, then the font name used to create that object will be used instead). If some cases, however, doing this conversion does not make sense, and this will be noted in the documentation for particular types of instance objects. If PROPERTY is not a built-in property, then this function will simply set its value if LOCALE is nil. However, if LOCALE is given, then this function will attempt to add VALUE as the instantiator for the given LOCALE, using `add-spec-to-specifier'. If the value of the property is not a specifier, it will automatically be converted into a 'generic specifier. The following symbols have predefined meanings: foreground The foreground color of the face. background The background color of the face. font The font used to display text covered by this face. display-table The display table of the face. background-pixmap The pixmap displayed in the background of the face. Only used by faces on X devices. underline Underline all text covered by this face. highlight Highlight all text covered by this face. Only used by faces on TTY devices. dim Dim all text covered by this face. Only used by faces on TTY devices. blinking Blink all text covered by this face. Only used by faces on TTY devices. reverse Reverse the foreground and background colors. Only used by faces on TTY devices. doc-string Description of what the face's normal use is. NOTE: This is not a specifier, unlike all the other built-in properties, and cannot contain locale-specific values. Fremove-face-property Remove a property from a face. For built-in properties, this is analogous to `remove-specifier'. See `remove-specifier' for the meaning of the LOCALE, TAG-SET, and EXACT-P arguments. Freset-face Clear all existing built-in specifications from FACE. This makes FACE inherit all its display properties from 'default. WARNING: Be absolutely sure you want to do this!!! It is a dangerous operation and is not undoable. Fface-doc-string Return the documentation string for FACE. Fset-face-doc-string Change the documentation string of FACE to DOC-STRING. Fface-font-name Return the font name of the given face, or nil if it is unspecified. DOMAIN is as in `face-font-instance'. Fface-font Return the font of the given face, or nil if it is unspecified. FACE may be either a face object or a symbol representing a face. LOCALE may be a locale (the instantiators for that particular locale will be returned), a locale type (the specifications for all locales of that type will be returned), 'all (all specifications will be returned), or nil (the actual specifier object will be returned). See `face-property' for more information. Fface-font-instance Return the instance of the given face's font in the given domain. FACE may be either a face object or a symbol representing a face. Normally DOMAIN will be a window or nil (meaning the selected window), and an instance object describing how the font appears in that particular window and buffer will be returned. See `face-property-instance' for more information. Fset-face-font Change the font of the given face. FACE may be either a face object or a symbol representing a face. FONT should be an instantiator (a string naming a font; e.g. under X this might be "-*-courier-medium-r-*-*-*-140-*-*-*-*-iso8859-*" for a 14-point upright medium-weight Courier font), a list of instantiators, an alist of specifications (each mapping a locale to an instantiator list), or a font specifier object. If FONT is an alist, LOCALE must be omitted. If FONT is a specifier object, LOCALE can be a locale, a locale type, 'all, or nil; see `copy-specifier' for its semantics. Otherwise LOCALE specifies the locale under which the specified instantiator(s) will be added, and defaults to 'global. See `set-face-property' for more information. Fface-foreground Return the foreground of the given face, or nil if it is unspecified. FACE may be either a face object or a symbol representing a face. LOCALE may be a locale (the instantiators for that particular locale will be returned), a locale type (the specifications for all locales of that type will be returned), 'all (all specifications will be returned), or nil (the actual specifier object will be returned). See `face-property' for more information. Fface-foreground-instance Return the instance of the given face's foreground in the given domain. FACE may be either a face object or a symbol representing a face. Normally DOMAIN will be a window or nil (meaning the selected window), and an instance object describing how the foreground appears in that particular window and buffer will be returned. See `face-property-instance' for more information. Fset-face-foreground Change the foreground of the given face. FACE may be either a face object or a symbol representing a face. COLOR should be an instantiator (a string naming a color; e.g. under X this might be "lightseagreen2" or "#F534B2"), a list of instantiators, an alist of specifications (each mapping a locale to an instantiator list), or a color specifier object. If COLOR is an alist, LOCALE must be omitted. If COLOR is a specifier object, LOCALE can be a locale, a locale type, 'all, or nil; see `copy-specifier' for its semantics. Otherwise LOCALE specifies the locale under which the specified instantiator(s) will be added, and defaults to 'global. See `set-face-property' for more information. Fface-background Return the background of the given face, or nil if it is unspecified. FACE may be either a face object or a symbol representing a face. LOCALE may be a locale (the instantiators for that particular locale will be returned), a locale type (the specifications for all locales of that type will be returned), 'all (all specifications will be returned), or nil (the actual specifier object will be returned). See `face-property' for more information. Fface-background-instance Return the instance of the given face's background in the given domain. FACE may be either a face object or a symbol representing a face. Normally DOMAIN will be a window or nil (meaning the selected window), and an instance object describing how the background appears in that particular window and buffer will be returned. See `face-property-instance' for more information. Fset-face-background Change the background of the given face. FACE may be either a face object or a symbol representing a face. COLOR should be an instantiator (a string naming a color; e.g. under X this might be "lightseagreen2" or "#F534B2"), a list of instantiators, an alist of specifications (each mapping a locale to an instantiator list), or a color specifier object. If COLOR is an alist, LOCALE must be omitted. If COLOR is a specifier object, LOCALE can be a locale, a locale type, 'all, or nil; see `copy-specifier' for its semantics. Otherwise LOCALE specifies the locale under which the specified instantiator(s) will be added, and defaults to 'global. See `set-face-property' for more information. Fface-background-pixmap Return the background pixmap of the given face, or nil if it is unspecified. This property is only used on X devices. FACE may be either a face object or a symbol representing a face. LOCALE may be a locale (the instantiators for that particular locale will be returned), a locale type (the specifications for all locales of that type will be returned), 'all (all specifications will be returned), or nil (the actual specifier object will be returned). See `face-property' for more information. Fface-background-pixmap-instance Return the instance of the given face's background pixmap in the given domain. FACE may be either a face object or a symbol representing a face. Normally DOMAIN will be a window or nil (meaning the selected window), and an instance object describing how the background appears in that particular window and buffer will be returned. See `face-property-instance' for more information. Fset-face-background-pixmap Change the background pixmap of the given face. This property is only used on X devices. FACE may be either a face object or a symbol representing a face. PIXMAP should be an instantiator (the name of a file of pixmap data, a string that is the contents of an XPM file if XPM support was compiled in, a vector of the from `[width height data]' specifying the pixmap data), a list of instantiators, an alist of specifications (each mapping a locale to an instantiator list), or an image specifier object. If PIXMAP is an alist, LOCALE must be omitted. If PIXMAP is a specifier object, LOCALE can be a locale, a locale type, 'all, or nil; see `copy-specifier' for its semantics. Otherwise LOCALE specifies the locale under which the specified instantiator(s) will be added, and defaults to 'global. See `set-face-property' for more information. Fface-display-table Return the display table of the given face. A vector (as returned by `make-display-table') will be returned. LOCALE may be a locale (the instantiators for that particular locale will be returned), a locale type (the specifications for all locales of that type will be returned), 'all (all specifications will be returned), or nil (the actual specifier object will be returned). See `face-property' for more information. Fface-display-table-instance Return the instance of FACE's display table in DOMAIN. A vector (as returned by `make-display-table') will be returned. See `face-property-instance' for the semantics of the DOMAIN argument. Fset-face-display-table Change the display table of the given face. DISPLAY-TABLE should be a vector as returned by `make-display-table'. See `set-face-property' for the semantics of the LOCALE, TAG-SET, and HOW-TO-ADD arguments. Fface-underline-p Return whether the given face is underlined. See `face-property-instance' for the semantics of the DOMAIN argument. Fset-face-underline-p Change whether the given face is underlined. See `set-face-property' for the semantics of the LOCALE, TAG-SET, and HOW-TO-ADD arguments. Fface-highlight-p Return whether the given face is highlighted (TTY domains only). See `face-property-instance' for the semantics of the DOMAIN argument. Fset-face-highlight-p Change whether the given face is highlighted (TTY locales only). See `set-face-property' for the semantics of the LOCALE, TAG-SET, and HOW-TO-ADD arguments. Fface-dim-p Return whether the given face is dimmed (TTY domains only). See `face-property-instance' for the semantics of the DOMAIN argument. Fset-face-dim-p Change whether the given face is dimmed (TTY locales only). See `set-face-property' for the semantics of the LOCALE, TAG-SET, and HOW-TO-ADD arguments. Fface-blinking-p Return whether the given face is blinking (TTY domains only). See `face-property-instance' for the semantics of the DOMAIN argument. Fset-face-blinking-p Change whether the given face is blinking (TTY locales only). See `set-face-property' for the semantics of the LOCALE, TAG-SET, and HOW-TO-ADD arguments. Fface-reverse-p Return whether the given face is reversed (TTY domains only). See `face-property-instance' for the semantics of the DOMAIN argument. Fset-face-reverse-p Change whether the given face is reversed (TTY locales only). See `set-face-property' for the semantics of the LOCALE, TAG-SET, and HOW-TO-ADD arguments. Fface-equal True if the given faces will display in the the same way. See `face-property-instance' for the semantics of the DOMAIN argument. Fface-differs-from-default-p True if the given face will display differently from the default face. See `face-property-instance' for the semantics of the DOMAIN argument. Ffrob-face-property Change the specifier for FACE's PROPERTY according to FUNC, in LOCALE. FUNC should be a function of two arguments (an instance and a device) that returns a modified name that is valid for the given device. If LOCALE specifies a valid domain (i.e. a window, frame, or device), this function instantiates the specifier over that domain, applies FUNC to the resulting instance, and adds the result back as an instantiator for that locale. Otherwise, LOCALE should be a locale, locale type, or 'all (defaults to 'all if omitted). For each specification thusly included: if the locale given is a valid domain, FUNC will be iterated over all valid instantiators for the device of the domain until a non-nil result is found (if there is no such result, the first valid instantiator is used), and that result substituted for the specification; otherwise, the process just outlined is iterated over each existing device and the concatenated results substituted for the specification. Fmake-face-bold Make the face bold, if possible. This will attempt to make the font bold for X locales and will set the highlight flag for TTY locales. See `face-property' for the semantics of the LOCALE argument. Fmake-face-italic Make the face italic, if possible. This will attempt to make the font italic for X locales and will set the underline flag for TTY locales. See `face-property' for the semantics of the LOCALE argument. Fmake-face-bold-italic Make the face bold and italic, if possible. This will attempt to make the font bold-italic for X locales and will set the highlight and underline flags for TTY locales. See `face-property' for the semantics of the LOCALE argument. Fmake-face-unbold Make the face non-bold, if possible. This will attempt to make the font non-bold for X locales and will unset the highlight flag for TTY locales. See `face-property' for the semantics of the LOCALE argument. Fmake-face-unitalic Make the face non-italic, if possible. This will attempt to make the font non-italic for X locales and will unset the underline flag for TTY locales. See `face-property' for the semantics of the LOCALE argument. Fmake-face-smaller Make the font of the given face be smaller, if possible. See `face-property' for the semantics of the LOCALE argument. Fmake-face-larger Make the font of the given face be larger, if possible. See `face-property' for the semantics of the LOCALE argument. Finvert-face Swap the foreground and background colors of the face. Fface-height Return the height of a face. See `face-property-instance' for the semantics of the DOMAIN argument. Finit-face-from-resources Initialize FACE from the resource database. If LOCALE is specified, it should be a frame, device, or 'global, and the face will be resourced over that locale. Otherwise, the face will be resourced over all possible locales (i.e. all frames, all devices, and 'global). Fmake-font-specifier Create a new `font' specifier object with the given specification list. SPEC-LIST can be a list of specifications (each of which is a cons of a locale and a list of instantiators), a single instantiator, or a list of instantiators. See `make-specifier' for more information about specifiers. Ffont-name Return the name of the FONT in the specified DOMAIN, if any. FONT should be a font specifier object and DOMAIN is normally a window and defaults to the selected window if omitted. This is equivalent to using `specifier-instance' and applying `font-instance-name' to the result. See `make-specifier' for more information about specifiers. Ffont-properties Return the properties of the FONT in the specified DOMAIN, if any. FONT should be a font specifier object and DOMAIN is normally a window and defaults to the selected window if omitted. This is equivalent to using `specifier-instance' and applying `font-instance-properties' to the result. See `make-specifier' for more information about specifiers. Ffont-truename Return the truename of the FONT in the specified DOMAIN, if any. FONT should be a font specifier object and DOMAIN is normally a window and defaults to the selected window if omitted. This is equivalent to using `specifier-instance' and applying `font-instance-truename' to the result. See `make-specifier' for more information about specifiers. Fmake-color-specifier Create a new `color' specifier object with the given specification list. SPEC-LIST can be a list of specifications (each of which is a cons of a locale and a list of instantiators), a single instantiator, or a list of instantiators. See `make-specifier' for a detailed description of how specifiers work. Fcolor-name Return the name of the COLOR in the specified DOMAIN, if any. COLOR should be a color specifier object and DOMAIN is normally a window and defaults to the selected window if omitted. This is equivalent to using `specifier-instance' and applying `color-instance-name' to the result. See `make-specifier' for more information about specifiers. Fcolor-rgb-components Return the RGB components of the COLOR in the specified DOMAIN, if any. COLOR should be a color specifier object and DOMAIN is normally a window and defaults to the selected window if omitted. This is equivalent to using `specifier-instance' and applying `color-instance-rgb-components' to the result. See `make-specifier' for more information about specifiers. Fstart-process-shell-command Start a program in a subprocess. Return the process object for it. Args are NAME BUFFER COMMAND &rest COMMAND-ARGS. NAME is name for process. It is modified if necessary to make it unique. BUFFER is the buffer or (buffer-name) to associate with the process. Process output goes at end of that buffer, unless you specify an output stream or filter function to handle the output. BUFFER may be also nil, meaning that this process is not associated with any buffer Third arg is command name, the name of a shell command. Remaining arguments are the arguments for the command. Wildcards and redirection are handled as usual in the shell. Fcall-process Call PROGRAM synchronously in separate process. The program's input comes from file INFILE (nil means `/dev/null'). Insert output in BUFFER before point; t means current buffer; nil for BUFFER means discard it; 0 means discard and don't wait. Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted. Remaining arguments are strings passed as command arguments to PROGRAM. If BUFFER is 0, returns immediately with value nil. Otherwise waits for PROGRAM to terminate and returns a numeric exit status or a signal description string. If you quit, the process is killed with SIGINT, or SIGKILL if you quit again. Fcall-process-region Send text from START to END to a synchronous process running PROGRAM. Delete the text if fourth arg DELETE is non-nil. Insert output in BUFFER before point; t means current buffer; nil for BUFFER means discard it; 0 means discard and don't wait. Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted. Remaining args are passed to PROGRAM at startup as command args. If BUFFER is 0, returns immediately with value nil. Otherwise waits for PROGRAM to terminate and returns a numeric exit status or a signal description string. If you quit, the process is first killed with SIGINT, then with SIGKILL if you quit again before the process exits. Fshell-command Execute string COMMAND in inferior shell; display output, if any. If COMMAND ends in ampersand, execute it asynchronously. Optional second arg non-nil (prefix arg, if interactive) means insert output in current buffer after point (leave mark after it). This cannot be done asynchronously. Fshell-command-on-region Execute string COMMAND in inferior shell with region as input. Normally display output (if any) in temp buffer `*Shell Command Output*'; Prefix arg means replace the region with it. Noninteractive args are START, END, COMMAND, FLAG. Noninteractively FLAG means insert output in place of text from START to END, and put point at the end, but don't alter the mark. If the output is one line, it is displayed in the echo area, but it is nonetheless available in buffer `*Shell Command Output*' even though that buffer is not automatically displayed. If there is no output or output is inserted in the current buffer then `*Shell Command Output*' is deleted. Fstart-process Start a program in a subprocess. Return the process object for it. Args are NAME BUFFER PROGRAM &rest PROGRAM-ARGS NAME is name for process. It is modified if necessary to make it unique. BUFFER is the buffer or (buffer-name) to associate with the process. Process output goes at end of that buffer, unless you specify an output stream or filter function to handle the output. BUFFER may be also nil, meaning that this process is not associated with any buffer Third arg is program file name. It is searched for as in the shell. Remaining arguments are strings to give program as arguments. INCODE and OUTCODE specify the coding-system objects used in input/output from/to the process. Fopen-network-stream Open a TCP connection for a service to a host. Returns a subprocess-object to represent the connection. Input and output work as for subprocesses; `delete-process' closes it. Args are NAME BUFFER HOST SERVICE. NAME is name for process. It is modified if necessary to make it unique. BUFFER is the buffer (or buffer-name) to associate with the process. Process output goes at end of that buffer, unless you specify an output stream or filter function to handle the output. BUFFER may be also nil, meaning that this process is not associated with any buffer Third arg is name of the host to connect to, or its IP address. Fourth arg SERVICE is name of the service desired, or an integer specifying a port number to connect to. Fshell-quote-argument Quote an argument for passing as argument to an inferior shell. Fexec-to-string Execute COMMAND as an external process and return the output of that process as a string Vglobal-map Default global keymap mapping XEmacs keyboard input into commands. The value is a keymap which is usually (but not necessarily) XEmacs's global map. Vesc-map Default keymap for ESC (meta) commands. The normal global definition of the character ESC indirects to this keymap. Vctl-x-map Default keymap for C-x commands. The normal global definition of the character C-x indirects to this keymap. Vctl-x-4-map Keymap for subcommands of C-x 4 Vctl-x-5-map Keymap for subcommands of C-x 5 Vmode-specific-map Keymap for characters following C-c. Fquit-char Return the character that causes a QUIT to happen. This is normally C-g. Optional arg DEVICE specifies the device that the information is returned for; nil means the current device. Fmake-tty-device Create a new device on TTY. TTY should be the name of a tty device file (e.g. "/dev/ttyp3" under SunOS et al.), as returned by the `tty' command. A value of nil means use the stdin and stdout as passed to XEmacs from the shell. If TERMINAL-TYPE is non-nil, it should be a string specifying the type of the terminal attached to the specified tty. If it is nil, the terminal type will be inferred from the TERM environment variable. Fmake-x-device Create a new device connected to DISPLAY. Optional argument ARGV-LIST is a list of strings describing command line options. Fdefine-obsolete-function-alias Define OLDFUN as an obsolete alias for function NEWFUN. This makes calling OLDFUN equivalent to calling NEWFUN and marks OLDFUN as obsolete. Fdefine-obsolete-variable-alias Define OLDVAR as an obsolete alias for varction NEWVAR. This makes referencing or setting OLDVAR equivalent to referencing or setting NEWVAR and marks OLDVAR as obsolete. Fextent-data Obsolete. Returns the `data' property of the given extent. Fset-extent-data Obsolete. Sets the `data' property of the given extent. Fset-extent-attribute Fextent-glyph Fextent-layout Fset-extent-layout Fx-create-screen Fframe-first-window Returns the topmost, leftmost window of FRAME. If omitted, FRAME defaults to the currently selected frame. Fx-display-color-p Returns non-nil if DEVICE is a color device. Fx-display-grayscale-p Returns non-nil if DEVICE is a grayscale device. Vafter-write-file-hooks Fkeymap-parent Returns the first parent of the given keymap. Fset-keymap-parent Makes the given keymap have (only) the given parent. Fadd-menu-item Obsolete. See the function `add-menu-button'. Fadd-menu Obsolete. See the function `add-submenu'. Fmake-pixmap Create a glyph with NAME as a pixmap specifier and locale LOCALE. The file should be in `XBM' or `XPM' format. If the XBMLANGPATH environment variable is set, it will be searched for matching files. Next, the directories listed in the `x-bitmap-file-path' variable will be searched (this variable is initialized from the "*bitmapFilePath" resource). Finally, the XEmacs etc/ directory (the value of `data-directory') will be searched. The file argument may also be a list of the form (width height data) where width and height are the size in pixels, and data is a string, containing the raw bits of the bitmap. (Bitmaps specified this way can only be one bit deep.) If compiled with support for XPM, the file argument may also be a string which is the contents of an XPM file (that is, a string beginning with the characters "/* XPM */"; see the XPM documentation). The optional second argument is the specifier locale for this pixmap glyph. The returned object is a glyph object. To get the actual pixmap object for a given frame, use the function `glyph-instance'. Fmake-image-specifier Create a new `image' specifier object with the given specification list. SPEC-LIST can be a list of specifications (each of which is a cons of a locale and a list of instantiators), a single instantiator, or a list of instantiators. See `make-specifier' for more information about specifiers. Vbuilt-in-glyph-specifiers A list of the built-in face properties that are specifiers. Fglyph-property Return GLYPH's value of the given PROPERTY. If LOCALE is omitted, the GLYPH's actual value for PROPERTY will be returned. For built-in properties, this will be a specifier object of a type appropriate to the property (e.g. a font or color specifier). For other properties, this could be anything. If LOCALE is supplied, then instead of returning the actual value, the specification(s) for the given locale or locale type will be returned. This will only work if the actual value of PROPERTY is a specifier (this will always be the case for built-in properties, but not or not may apply to user-defined properties). If the actual value of PROPERTY is not a specifier, this value will simply be returned regardless of LOCALE. The return value will be a list of instantiators (e.g. strings specifying a font or color name), or a list of specifications, each of which is a cons of a locale and a list of instantiators. Specifically, if LOCALE is a particular locale (a buffer, window, frame, device, or 'global), a list of instantiators for that locale will be returned. Otherwise, if LOCALE is a locale type (one of the symbols 'buffer, 'window, 'frame, 'device, 'device-class, or 'device-type), the specifications for all locales of that type will be returned. Finally, if LOCALE is 'all, the specifications for all locales of all types will be returned. The specifications in a specifier determine what the value of PROPERTY will be in a particular "domain" or set of circumstances, which is typically a particular Emacs window along with the buffer it contains and the frame and device it lies within. The value is derived from the instantiator associated with the most specific locale (in the order buffer, window, frame, device, and 'global) that matches the domain in question. In other words, given a domain (i.e. an Emacs window, usually), the specifier for PROPERTY will first be searched for a specification whose locale is the buffer contained within that window; then for a specification whose locale is the window itself; then for a specification whose locale is the frame that the window is contained within; etc. The first instantiator that is valid for the domain (usually this means that the instantiator is recognized by the device [i.e. the X server or TTY device] that the domain is on. The function `glyph-property-instance' actually does all this, and is used to determine how to display the glyph. See `set-glyph-property' for the built-in property-names. Fconvert-glyph-property-into-specifier Convert PROPERTY on GLYPH into a specifier, if it's not already. Fglyph-property-instance Return the instance of GLYPH's PROPERTY in the specified DOMAIN. Under most circumstances, DOMAIN will be a particular window, and the returned instance describes how the specified property actually is displayed for that window and the particular buffer in it. Note that this may not be the same as how the property appears when the buffer is displayed in a different window or frame, or how the property appears in the same window if you switch to another buffer in that window; and in those cases, the returned instance would be different. The returned instance will typically be a color-instance, font-instance, or pixmap-instance object, and you can query it using the appropriate object-specific functions. For example, you could use `color-instance-rgb-components' to find out the RGB (red, green, and blue) components of how the 'background property of the 'highlight glyph is displayed in a particular window. The results might be different from the results you would get for another window (perhaps the user specified a different color for the frame that window is on; or perhaps the same color was specified but the window is on a different X server, and that X server has different RGB values for the color from this one). DOMAIN defaults to the selected window if omitted. DOMAIN can be a frame or device, instead of a window. The value returned for a such a domain is used in special circumstances when a more specific domain does not apply; for example, a frame value might be used for coloring a toolbar, which is conceptually attached to a frame rather than a particular window. The value is also useful in determining what the value would be for a particular window within the frame or device, if it is not overridden by a more specific specification. If PROPERTY does not name a built-in property, its value will simply be returned unless it is a specifier object, in which case it will be instanced using `specifier-instance'. Optional arguments DEFAULT and NO-FALLBACK are the same as in `specifier-instance'. Fset-glyph-property Change a property of a GLYPH. NOTE: If you want to remove a property from a glyph, use `remove-glyph-property' rather than attempting to set a value of nil for the property. For built-in properties, the actual value of the property is a specifier and you cannot change this; but you can change the specifications within the specifier, and that is what this function will do. For user-defined properties, you can use this function to either change the actual value of the property or, if this value is a specifier, change the specifications within it. If PROPERTY is a built-in property, the specifications to be added to this property can be supplied in many different ways: -- If VALUE is a simple instantiator (e.g. a string naming a font or color) or a list of instantiators, then the instantiator(s) will be added as a specification of the property for the given LOCALE (which defaults to 'global if omitted). -- If VALUE is a list of specifications (each of which is a cons of a locale and a list of instantiators), then LOCALE must be nil (it does not make sense to explicitly specify a locale in this case), and specifications will be added as given. -- If VALUE is a specifier (as would be returned by `glyph-property' if no LOCALE argument is given), then some or all of the specifications in the specifier will be added to the property. In this case, the function is really equivalent to `copy-specifier' and LOCALE has the same semantics (if it is a particular locale, the specification for the locale will be copied; if a locale type, specifications for all locales of that type will be copied; if nil or 'all, then all specifications will be copied). HOW-TO-ADD should be either nil or one of the symbols 'prepend, 'append, 'remove-tag-set-prepend, 'remove-tag-set-append, 'remove-locale, 'remove-locale-type, or 'remove-all. See `copy-specifier' and `add-spec-to-specifier' for a description of what each of these means. Most of the time, you do not need to worry about this argument; the default behavior usually is fine. In general, it is OK to pass an instance object (e.g. as returned by `glyph-property-instance') as an instantiator in place of an actual instantiator. In such a case, the instantiator used to create that instance object will be used (for example, if you set a font-instance object as the value of the 'font property, then the font name used to create that object will be used instead). If some cases, however, doing this conversion does not make sense, and this will be noted in the documentation for particular types of instance objects. If PROPERTY is not a built-in property, then this function will simply set its value if LOCALE is nil. However, if LOCALE is given, then this function will attempt to add VALUE as the instantiator for the given LOCALE, using `add-spec-to-specifier'. If the value of the property is not a specifier, it will automatically be converted into a 'generic specifier. The following symbols have predefined meanings: image The image used to display the glyph. baseline Percent above baseline that glyph is to be displayed. contrib-p Whether the glyph contributes to the height of the line it's on. face Face of this glyph (*not* a specifier). Fremove-glyph-property Remove a property from a glyph. For built-in properties, this is analogous to `remove-specifier'. See `remove-specifier' for the meaning of the LOCALE, TAG-SET, and EXACT-P arguments. Fglyph-face Return the face of GLYPH. Fset-glyph-face Change the face of GLYPH to FACE. Fglyph-image Return the image of the given glyph, or nil if it is unspecified. LOCALE may be a locale (the instantiators for that particular locale will be returned), a locale type (the specifications for all locales of that type will be returned), 'all (all specifications will be returned), or nil (the actual specifier object will be returned). See `glyph-property' for more information. Fglyph-image-instance Return the instance of the given glyph's image in the given domain. Normally DOMAIN will be a window or nil (meaning the selected window), and an instance object describing how the image appears in that particular window and buffer will be returned. See `glyph-property-instance' for more information. Fset-glyph-image Change the image of the given glyph. SPEC should be an instantiator (a string or vector; see `image-specifier-p' for a description of possible values here), a list of (possibly tagged) instantiators, an alist of specifications (each mapping a locale to an instantiator list), or an image specifier object. If SPEC is an alist, LOCALE must be omitted. If SPEC is a specifier object, LOCALE can be a locale, a locale type, 'all, or nil; see `copy-specifier' for its semantics. Otherwise LOCALE specifies the locale under which the specified instantiator(s) will be added, and defaults to 'global. See `set-glyph-property' for more information. Fglyph-contrib-p Return whether GLYPH contributes to its line height. LOCALE may be a locale (the instantiators for that particular locale will be returned), a locale type (the specifications for all locales of that type will be returned), 'all (all specifications will be returned), or nil (the actual specifier object will be returned). See `glyph-property' for more information. Fglyph-contrib-p-instance Return the instance of the GLYPH's 'contrib-p property in the given domain. Normally DOMAIN will be a window or nil (meaning the selected window), and an instance object describing what the 'contrib-p property is in that particular window and buffer will be returned. See `glyph-property-instance' for more information. Fset-glyph-contrib-p Change the contrib-p of the given glyph. SPEC should be an instantiator (t or nil), a list of (possibly tagged) instantiators, an alist of specifications (each mapping a locale to an instantiator list), or a boolean specifier object. If SPEC is an alist, LOCALE must be omitted. If SPEC is a specifier object, LOCALE can be a locale, a locale type, 'all, or nil; see `copy-specifier' for its semantics. Otherwise LOCALE specifies the locale under which the specified instantiator(s) will be added, and defaults to 'global. See `set-glyph-property' for more information. Fglyph-baseline Return the baseline of the given glyph, or nil if it is unspecified. LOCALE may be a locale (the instantiators for that particular locale will be returned), a locale type (the specifications for all locales of that type will be returned), 'all (all specifications will be returned), or nil (the actual specifier object will be returned). See `glyph-property' for more information. Fglyph-baseline-instance Return the instance of the given glyph's baseline in the given domain. Normally DOMAIN will be a window or nil (meaning the selected window), and an integer or nil (specifying the baseline in that particular window and buffer) will be returned. See `glyph-property-instance' for more information. Fset-glyph-baseline Change the baseline of the given glyph. SPEC should be an instantiator (an integer [a percentage above the baseline of the line the glyph is on] or nil), a list of (possibly tagged) instantiators, an alist of specifications (each mapping a locale to an instantiator list), or a generic specifier object. If SPEC is an alist, LOCALE must be omitted. If SPEC is a specifier object, LOCALE can be a locale, a locale type, 'all, or nil; see `copy-specifier' for its semantics. Otherwise LOCALE specifies the locale under which the specified instantiator(s) will be added, and defaults to 'global. See `set-glyph-property' for more information. Fmake-glyph Create a new `glyph' object with the given specification list. SPEC-LIST can be a list of specifications (each of which is a cons of a locale and a list of inst-pairs, each of which is a cons of a tag-set and an instantiator), a single instantiator, a list of instantiators, or almost any other reasonable form (specifically anything accepted by `canonicalize-spec-list'). SPEC-LIST is used to initialize the glyph's 'image property, which is a specifier. See `make-specifier' for more information about specifiers. Fmapcar-extents Applies FUNCTION to all extents which overlap a region in BUFFER. The region is is delimited by FROM and TO. A list of the values returned by FUNCTION is returned. An optional PREDICATE may be used to further limit the extents over which FUNCTION is mapped. The optional arguments FLAGS, PROPERTY, and VALUE may also be used to control the extents passed to PREDICATE or FUNCTION. See also `map-extents'. Fextent-string Return the string delimited by the bounds of EXTENT. Fbackquote Expand the internal representation of a backquoted TEMPLATE into a lisp form. The backquote character is like the quote character in that it prevents the template which follows it from being evaluated, except that backquote permits you to evaluate portions of the quoted template. A comma character inside TEMPLATE indicates that the following item should be evaluated. A comma character may be followed by an at-sign, which indicates that the form which follows should be evaluated and inserted and "spliced" into the template. Forms following ,@ must evaluate to lists. Here is how to use backquotes: (setq p 'b q '(c d e)) `(a ,p ,@q) -> (a b c d e) `(a . b) -> (a . b) `(a . ,p) -> (a . b) The XEmacs lisp reader expands lisp backquotes as it reads them. Examples: `atom is read as (backquote atom) `(a ,b ,@(c d e)) is read as (backquote (a (\, b) (\,\@ (c d e)))) `(a . ,p) is read as (backquote (a \, p)) (backquote TEMPLATE) is a macro that produces code to construct TEMPLATE. Note that this is very slow in interpreted code, but fast if you compile. TEMPLATE is one or more nested lists or vectors, which are `almost quoted'. They are copied recursively, with elements preceded by comma evaluated. (backquote (a b)) == (list 'a 'b) (backquote (a [b c])) == (list 'a (vector 'b 'c)) However, certain special lists are not copied. They specify substitution. Lists that look like (\, EXP) are evaluated and the result is substituted. (backquote (a (\, (+ x 5)))) == (list 'a (+ x 5)) Elements of the form (\,\@ EXP) are evaluated and then all the elements of the result are substituted. This result must be a list; it may be `nil'. Elements of the form (\,\. EXP) are evaluated and then all the elements of the result are concatenated to the list of preceding elements in the list. They must occur as the last element of a list (not a vector). EXP may evaluate to nil. As an example, a simple macro `push' could be written: (defmacro push (v l) `(setq ,l (cons ,@(list v l)))) or as (defmacro push (v l) `(setq ,l (cons ,v ,l))) For backwards compatibility, old-style emacs-lisp backquotes are still read. OLD STYLE NEW STYLE (` (foo (, bar) (,@ bing))) `(foo ,bar ,@bing) Because of the old-style backquote support, you cannot use a new-style backquoted form as the first element of a list. Perhaps some day this restriction will go away, but for now you should be wary of it: (`(this ,will ,@fail)) ((` (but (, this) will (,@ work)))) This is an extremely rare thing to need to do in lisp. Fbq-list* Returns a list of its arguments with last cons a dotted pair. Fopen-line Insert a newline and leave point before it. With arg N, insert N newlines. Fsplit-line Split current line, moving portion beyond point vertically down. Fquoted-insert Read next input character and insert it. This is useful for inserting control characters. You may also type up to 3 octal digits, to insert a character with that code. In overwrite mode, this function inserts the character anyway, and does not handle octal digits specially. This means that if you use overwrite as your normal editing mode, you can use this function to insert characters when necessary. In binary overwrite mode, this function does overwrite, and octal digits are interpreted as a character code. This is supposed to make this function useful in editing binary files. Fdelete-indentation Join this line to previous and fix up whitespace at join. If there is a fill prefix, delete it from the beginning of this line. With argument, join this line to following line. Ffixup-whitespace Fixup white space between objects around point. Leave one space or none, according to the context. Fdelete-horizontal-space Delete all spaces and tabs around point. Fjust-one-space Delete all spaces and tabs around point, leaving one space. Fdelete-blank-lines On blank line, delete all surrounding blank lines, leaving just one. On isolated blank line, delete that one. On nonblank line, delete any immediately following blank lines. Fback-to-indentation Move point to the first non-whitespace character on this line. Fnewline-and-indent Insert a newline, then indent according to major mode. Indentation is done using the value of `indent-line-function'. In programming language modes, this is the same as TAB. In some text modes, where TAB inserts a tab, this command indents to the column specified by the variable `left-margin'. Freindent-then-newline-and-indent Reindent current line, insert newline, then indent the new line. Indentation of both lines is done according to the current major mode, which means calling the current value of `indent-line-function'. In programming language modes, this is the same as TAB. In some text modes, where TAB inserts a tab, this indents to the column specified by the variable `left-margin'. Fbackward-delete-char-untabify Delete characters backward, changing tabs into spaces. Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil. Interactively, ARG is the prefix arg (default 1) and KILLP is t if a prefix arg was specified. Fzap-to-char Kill up to and including ARG'th occurrence of CHAR. Goes backward if ARG is negative; error if CHAR not found. Fbeginning-of-buffer Move point to the beginning of the buffer; leave mark at previous position. With arg N, put point N/10 of the way from the true beginning. Don't use this command in Lisp programs! (goto-char (point-min)) is faster and avoids clobbering the mark. Fend-of-buffer Move point to the end of the buffer; leave mark at previous position. With arg N, put point N/10 of the way from the true end. Don't use this command in Lisp programs! (goto-char (point-max)) is faster and avoids clobbering the mark. Fmark-beginning-of-buffer Push a mark at the beginning of the buffer; leave point where it is. With arg N, push mark N/10 of the way from the true beginning. Fmark-end-of-buffer Push a mark at the end of the buffer; leave point where it is. With arg N, push mark N/10 of the way from the true end. Fmark-whole-buffer Put point at beginning and mark at end of buffer. You probably should not use this function in Lisp programs; it is usually a mistake for a Lisp function to use any subroutine that uses or sets the mark. Feval-current-buffer Evaluate the current buffer as Lisp code. Programs can pass argument PRINTFLAG which controls printing of output: nil means discard it; anything else is stream for print. Fcount-lines-region Print number of lines and characters in the region. Fcount-lines-buffer Print number of lines and charcters in the specified buffer. Fwhat-line Print the current line number (in the buffer) of point. Fcount-lines Return number of lines between START and END. This is usually the number of newlines between them, but can be one more if START is not equal to END and the greater of them is not at the start of a line. Fwhat-cursor-position Print info on cursor position (on screen and within buffer). Ffundamental-mode Major mode not specialized for anything in particular. Other major modes are defined by comparison with this one. Feval-expression Evaluate EXPRESSION and print value in minibuffer. Value is also consed on to front of the variable `values'. Fedit-and-eval-command Prompting with PROMPT, let user edit COMMAND and eval result. COMMAND is a Lisp expression. Let user edit that expression in the minibuffer, then read and evaluate the result. Frepeat-complex-command Edit and re-evaluate last complex command, or ARGth from last. A complex command is one which used the minibuffer. The command is placed in the minibuffer as a Lisp form for editing. The result is executed, repeating the command as changed. If the command has been changed or is not the most recent previous command it is added to the front of the command history. You can use the minibuffer history commands \<minibuffer-local-map>\[next-history-element] and \[previous-history-element] to get different commands to edit and resubmit. Fgoto-line Goto line ARG, counting from line 1 at beginning of buffer. Fundo Undo some previous changes. Repeat this command to undo more changes. A numeric argument serves as a repeat count. Vpending-undo-list Within a run of consecutive undo commands, list remaining to be undone. Fundo-start Set `pending-undo-list' to the front of the undo list. The next call to `undo-more' will undo the most recently made change. Fundo-more Undo back N undo-boundaries beyond what was already undone recently. Call `undo-start' to get ready to undo recent changes, then call `undo-more' one or more times to undo them. Fcall-with-transparent-undo Apply FN to ARGS, and then undo all changes made by FN to the current buffer. The undo records are processed even if FN returns non-locally. There is no trace of the changes made by FN in the buffer's undo history. You can use this in a write-file-hooks function with continue-save-buffer to make the contents of a disk file differ from its in-memory buffer. Funiversal-argument Begin a numeric argument for the following command. Digits or minus sign following \[universal-argument] make up the numeric argument. \[universal-argument] following the digits or minus sign ends the argument. \[universal-argument] without digits or minus sign provides 4 as argument. Repeating \[universal-argument] without digits or minus sign multiplies the argument by 4 each time. Fdigit-argument Part of the numeric argument for the next command. \[universal-argument] following digits or minus sign ends the argument. Fnegative-argument Begin a negative numeric argument for the next command. \[universal-argument] following digits or minus sign ends the argument. Fforward-to-indentation Move forward ARG lines and position at first nonblank character. Fbackward-to-indentation Move backward ARG lines and position at first nonblank character. Vkill-whole-line *If non-nil, `kill-line' with no arg at beg of line kills the whole line. Fkill-line Kill the rest of the current line; if no nonblanks there, kill thru newline. With prefix argument, kill that many lines from point. Negative arguments kill lines backward. When calling from a program, nil means "no arg", a number counts as a prefix arg. If `kill-whole-line' is non-nil, then kill the whole line when given no argument at the beginning of a line. Fbackward-kill-line Kill back to the beginning of the line. Vkill-hooks Functions run when something is added to the XEmacs kill ring. These functions are called with one argument, the string most recently cut or copied. You can use this to, for example, make the most recent kill become the X Clipboard selection. Vkill-ring List of killed text sequences. In order to maintain correct interaction with cut-and-paste facilities offered by window systems, the functions `kill-new', `kill-append', and `current-kill' should be used to access the kill ring, instead of using this variable directly. Vkill-ring-max *Maximum length of kill ring before oldest elements are thrown away. Vkill-ring-yank-pointer The tail of the kill ring whose car is the last thing yanked. Fkill-new Make STRING the latest kill in the kill ring. Set the kill-ring-yank pointer to point to it. Runs `kill-hooks'. Fkill-append Append STRING to the end of the latest kill in the kill ring. If BEFORE-P is non-nil, prepend STRING to the kill. Runs `kill-hooks'. Fcurrent-kill Rotate the yanking point by N places, and then return that kill. If optional arg DO-NOT-MOVE is non-nil, then don't actually move the yanking point; just return the Nth kill forward. Fkill-region Kill between point and mark. The text is deleted but saved in the kill ring. The command \[yank] can retrieve it from there. (If you want to kill and then yank immediately, use \[copy-region-as-kill].) This is the primitive for programs to kill text (as opposed to deleting it). Supply two arguments, character numbers indicating the stretch of text to be killed. Any command that calls this function is a "kill command". If the previous command was also a kill command, the text killed this time appends to the text killed last time to make one entry in the kill ring. Fcopy-region-as-kill Save the region as if killed, but don't kill it. Runs `kill-hooks'. Fkill-ring-save Save the region as if killed, but don't kill it. This command is similar to `copy-region-as-kill', except that it gives visual feedback indicating the extent of the region being copied. Fappend-next-kill Cause following command, if it kills, to append to previous kill. Fyank-pop Replace just-yanked stretch of killed text with a different stretch. This command is allowed only immediately after a `yank' or a `yank-pop'. At such a time, the region contains a stretch of reinserted previously-killed text. `yank-pop' deletes that text and inserts in its place a different stretch of killed text. With no argument, the previous kill is inserted. With argument N, insert the Nth previous kill. If N is negative, this is a more recent kill. The sequence of kills wraps around, so that after the oldest one comes the newest one. Fyank Reinsert the last stretch of killed text. More precisely, reinsert the stretch of killed text most recently killed OR yanked. Put point at end, and set mark at beginning. With just C-u as argument, same but put point at beginning (and mark at end). With argument N, reinsert the Nth most recently killed stretch of killed text. See also the command \[yank-pop]. Frotate-yank-pointer Rotate the yanking point in the kill ring. With argument, rotate that many kills forward (or backward, if negative). Finsert-buffer Insert after point the contents of BUFFER. Puts mark after the inserted text. BUFFER may be a buffer or a buffer name. Fappend-to-buffer Append to specified buffer the text of the region. It is inserted into that buffer before its point. When calling from a program, give three arguments: BUFFER (or buffer name), START and END. START and END specify the portion of the current buffer to be copied. Fprepend-to-buffer Prepend to specified buffer the text of the region. It is inserted into that buffer after its point. When calling from a program, give three arguments: BUFFER (or buffer name), START and END. START and END specify the portion of the current buffer to be copied. Fcopy-to-buffer Copy to specified buffer the text of the region. It is inserted into that buffer, replacing existing text there. When calling from a program, give three arguments: BUFFER (or buffer name), START and END. START and END specify the portion of the current buffer to be copied. Fmark Return this buffer's mark value as integer, or nil if no mark. If `zmacs-regions' is true, then this returns nil unless the region is currently in the active (highlighted) state. With an argument of t, this returns the mark (if there is one) regardless of the active-region state. You should *generally* not use the mark unless the region is active, if the user has expressed a preference for the active-region model. If you are using this in an editing command, you are most likely making a mistake; see the documentation of `set-mark'. Fset-mark Set this buffer's mark to POS. Don't use this function! That is to say, don't use this function unless you want the user to see that the mark has moved, and you want the previous mark position to be lost. Normally, when a new mark is set, the old one should go on the stack. This is why most applications should use push-mark, not set-mark. Novice Emacs Lisp programmers often try to use the mark for the wrong purposes. The mark saves a location for the user's convenience. Most editing commands should not alter the mark. To remember a location for internal use in the Lisp program, store it in a Lisp variable. Example: (let ((beg (point))) (forward-line 1) (delete-region beg (point))). Vmark-ring The list of former marks of the current buffer, most recent first. Vmark-ring-max *Maximum size of mark ring. Start discarding off end if gets this big. Vglobal-mark-ring The list of saved global marks, most recent first. Vglobal-mark-ring-max *Maximum size of global mark ring. Start discarding off end if gets this big. Fset-mark-command Set mark at where point is, or jump to mark. With no prefix argument, set mark, push old mark position on local mark ring, and push mark on global mark ring. With argument, jump to mark, and pop a new position for mark off the ring (does not affect global mark ring). Novice Emacs Lisp programmers often try to use the mark for the wrong purposes. See the documentation of `set-mark' for more information. Fpush-mark Set mark at LOCATION (point, by default) and push old mark on mark ring. If the last global mark pushed was not in the current buffer, also push LOCATION on the global mark ring. Display `Mark set' unless the optional second arg NOMSG is non-nil. Activate mark if optional third arg ACTIVATE-REGION non-nil. Novice Emacs Lisp programmers often try to use the mark for the wrong purposes. See the documentation of `set-mark' for more information. Fpop-mark Pop off mark ring into the buffer's actual mark. Does not set point. Does nothing if mark ring is empty. Fexchange-point-and-mark Put the mark where point is now, and point where the mark is now. Fmark-something internal function used by mark-sexp, mark-word, etc. Fpop-global-mark Pop off global mark ring and jump to the top location. Vnext-line-add-newlines *If non-nil, `next-line' inserts newline to avoid `end of buffer' error. Fnext-line Move cursor vertically down ARG lines. If there is no character in the target line exactly under the current column, the cursor is positioned after the character in that line which spans this column, or at the end of the line if it is not long enough. If there is no line in the buffer after this one, behavior depends on the value of `next-line-add-newlines'. If non-nil, a newline character is inserted to create a line and the cursor moves to that line. Otherwise the cursor is moved to the end of the buffer if it is not already there and an error is signaled. The command \[set-goal-column] can be used to create a semipermanent goal column to which this command always moves. Then it does not try to move vertically. This goal column is stored in `goal-column', which is nil when there is none. If you are thinking of using this in a Lisp program, consider using `forward-line' instead. It is usually easier to use and more reliable (no dependence on goal column, etc.). Fprevious-line Move cursor vertically up ARG lines. If there is no character in the target line exactly over the current column, the cursor is positioned after the character in that line which spans this column, or at the end of the line if it is not long enough. The command \[set-goal-column] can be used to create a semipermanent goal column to which this command always moves. Then it does not try to move vertically. If you are thinking of using this in a Lisp program, consider using `forward-line' with a negative argument instead. It is usually easier to use and more reliable (no dependence on goal column, etc.). Vtrack-eol *Non-nil means vertical motion starting at end of line keeps to ends of lines. This means moving to the end of each line moved onto. The beginning of a blank line does not count as the end of a line. Vgoal-column *Semipermanent goal column for vertical motion, as set by \[set-goal-column], or nil. Vtemporary-goal-column Current goal column for vertical motion. It is the column where point was at the start of current run of vertical motion commands. When the `track-eol' feature is doing its job, the value is 9999. Fset-goal-column Set the current horizontal position as a goal for \[next-line] and \[previous-line]. Those commands will move to this position in the line moved to rather than trying to keep the same horizontal position. With a non-nil argument, clears out the goal column so that \[next-line] and \[previous-line] resume vertical motion. The goal column is stored in the variable `goal-column'. Fscroll-other-window-down Scroll the "other window" down. Fbeginning-of-buffer-other-window Move point to the beginning of the buffer in the other window. Leave mark at previous position. With arg N, put point N/10 of the way from the true beginning. Fend-of-buffer-other-window Move point to the end of the buffer in the other window. Leave mark at previous position. With arg N, put point N/10 of the way from the true end. Ftranspose-chars Interchange characters around point, moving forward one character. With prefix arg ARG, effect is to take character before point and drag it forward past ARG other characters (backward if ARG negative). If no argument and at end of line, the previous two chars are exchanged. Ftranspose-words Interchange words around point, leaving point at end of them. With prefix arg ARG, effect is to take word before or around point and drag it forward past ARG other words (backward if ARG negative). If ARG is zero, the words around or after point and around or after mark are interchanged. Ftranspose-sexps Like \[transpose-words] but applies to sexps. Does not work on a sexp that point is in the middle of if it is a list or string. Ftranspose-lines Exchange current line and previous line, leaving point after both. With argument ARG, takes previous line and moves it past ARG lines. With argument 0, interchanges line point is in with line mark is in. Vcomment-column *Column to indent right-margin comments to. Setting this variable automatically makes it local to the current buffer. Each mode establishes a different default value for this variable; you can set the value for a particular mode using that mode's hook. Vcomment-start *String to insert to start a new comment, or nil if no comment syntax defined. Vcomment-start-skip *Regexp to match the start of a comment plus everything up to its body. If there are any $...$ pairs, the comment delimiter text is held to begin at the place matched by the close of the first pair. Vcomment-end *String to insert to end a new comment. Should be an empty string if comments are terminated by end-of-line. Vcomment-indent-hook Obsolete variable for function to compute desired indentation for a comment. Use `comment-indent-function' instead. This function is called with no args with point at the beginning of the comment's starting delimiter. Vcomment-indent-function Function to compute desired indentation for a comment. This function is called with no args with point at the beginning of the comment's starting delimiter. Findent-for-comment Indent this line's comment to comment column, or insert an empty comment. Fset-comment-column Set the comment column based on point. With no arg, set the comment column to the current column. With just minus as arg, kill any comment on this line. With any other arg, set comment column to indentation of the previous comment and then align or create a comment on this line at that column. Fkill-comment Kill the comment on this line, if any. With argument, kill comments on that many lines starting with this one. Fcomment-region Comment or uncomment each line in the region. With just C-u prefix arg, uncomment each line in region. Numeric prefix arg ARG means use ARG comment characters. If ARG is negative, delete that many comment characters instead. Comments are terminated on each line, even for syntax in which newline does not end the comment. Blank lines do not get comments. Fprefix-region Add a prefix string to each line between mark and point. Fbackward-word Move backward until encountering the end of a word. With argument, do this that many times. In programs, it is faster to call `forward-word' with negative arg. Fmark-word Set mark arg words away from point. Fkill-word Kill characters forward until encountering the end of a word. With argument, do this that many times. Fbackward-kill-word Kill characters backward until encountering the end of a word. With argument, do this that many times. Fcurrent-word Return the word point is on (or a nearby word) as a string. If optional arg STRICT is non-nil, return nil unless point is within or adjacent to a word. If point is not between two word-constituent characters, but immediately follows one, move back first. Otherwise, if point precedes a word constituent, move forward first. Otherwise, move backwards until a word constituent is found and get that word; if you a newlines is reached first, move forward instead. Vfill-prefix *String for filling to insert at front of new line, or nil for none. Setting this variable automatically makes it local to the current buffer. Vauto-fill-inhibit-regexp *Regexp to match lines which should not be auto-filled. Vcomment-multi-line *Non-nil means \[indent-new-comment-line] should continue same comment on new line, with no new terminator or starter. This is obsolete because you might as well use \[newline-and-indent]. Findent-new-comment-line Break line at point and indent, continuing comment if within one. This indents the body of the continued comment under the previous comment line. This command is intended for styles where you write a comment per line, starting a new comment (and terminating it if necessary) on each line. If you want to continue one comment across several lines, use \[newline-and-indent]. Fauto-fill-mode Toggle auto-fill mode. With arg, turn auto-fill mode on if and only if arg is positive. In auto-fill mode, inserting a space at a column beyond `fill-column' automatically breaks the line at a previous space. Fauto-fill-function Automatically break line at a previous space, in insertion of text. Fturn-on-auto-fill Unconditionally turn on Auto Fill mode. Fset-fill-column Set `fill-column' to current column, or to argument if given. The variable `fill-column' has a separate value for each buffer. Fset-selective-display Set `selective-display' to ARG; clear it if no arg. When the value of `selective-display' is a number > 0, lines whose indentation is >= that value are not displayed. The variable `selective-display' has a separate value for each buffer. Fnuke-selective-display Ensure that the buffer is not in selective-display mode. If `selective-display' is t, then restore the buffer text to it's original state before disabling selective display. Voverwrite-mode-textual The string displayed in the modeline when in overwrite mode. Voverwrite-mode-binary The string displayed in the modeline when in binary overwrite mode. Foverwrite-mode Toggle overwrite mode. With arg, turn overwrite mode on iff arg is positive. In overwrite mode, printing characters typed in replace existing text on a one-for-one basis, rather than pushing it to the right. At the end of a line, such characters extend the line. Before a tab, such characters insert until the tab is filled in. \[quoted-insert] still inserts characters in overwrite mode; this is supposed to make it easier to insert characters when necessary. Fbinary-overwrite-mode Toggle binary overwrite mode. With arg, turn binary overwrite mode on iff arg is positive. In binary overwrite mode, printing characters typed in replace existing text. Newlines are not treated specially, so typing at the end of a line joins the line to the next, with the typed character between them. Typing before a tab character simply replaces the tab with the character typed. \[quoted-insert] replaces the text at the cursor, just as ordinary typing characters do. Note that binary overwrite mode is not its own minor mode; it is a specialization of overwrite-mode, entered by setting the `overwrite-mode' variable to `overwrite-mode-binary'. Fline-number-mode Toggle Line Number mode. With arg, turn Line Number mode on iff arg is positive. When Line Number mode is enabled, the line number appears in the modeline. Vblink-matching-paren *Non-nil means show matching open-paren when close-paren is inserted. Vblink-matching-paren-distance *If non-nil, is maximum distance to search for matching open-paren. Fblink-matching-open Move cursor momentarily to the beginning of the sexp before point. Fset-variable Set VARIABLE to VALUE. VALUE is a Lisp object. When using this interactively, supply a Lisp expression for VALUE. If you want VALUE to be a string, you must surround it with doublequotes. If VARIABLE has a `variable-interactive' property, that is used as if it were the arg to `interactive' (which see) to interactively read the value. Factivate-region Activate the region, if `zmacs-regions' is true. Setting `zmacs-regions' to true causes LISPM-style active regions to be used. This function has no effect if `zmacs-regions' is false. Fregion-exists-p Non-nil iff the region exists. If active regions are in use (i.e. `zmacs-regions' is true), this means that the region is active. Otherwise, this means that the user has pushed a mark in this buffer at some point in the past. The functions `region-beginning' and `region-end' can be used to find the limits of the region. Fregion-active-p Non-nil iff the region is active. If `zmacs-regions' is true, this is equivalent to `region-exists-p'. Otherwise, this function always returns false. Fcapitalize-region-or-word Capitalize the selected region or the following word (or ARG words). Fupcase-region-or-word Upcase the selected region or the following word (or ARG words). Fdowncase-region-or-word Downcase the selected region or the following word (or ARG words). Vzmacs-activate-region-hook Function or functions called when the region becomes active; see the variable `zmacs-regions'. Vzmacs-deactivate-region-hook Function or functions called when the region becomes inactive; see the variable `zmacs-regions'. Vzmacs-update-region-hook Function or functions called when the active region changes. This is called after each command that sets `zmacs-region-stays' to t. See the variable `zmacs-regions'. Vzmacs-region-extent The extent of the zmacs region; don't use this. Vzmacs-region-rectangular-p Whether the zmacs region is a rectangle; don't use this. Fzmacs-activate-region Make the region between `point' and `mark' be active (highlighted), if `zmacs-regions' is true. Only a very small number of commands should ever do this. Calling this function will call the hook `zmacs-activate-region-hook', if the region was previously inactive. Calling this function ensures that the region stays active after the current command terminates, even if `zmacs-region-stays' is not set. Returns t if the region was activated (i.e. if `zmacs-regions' if t). Fzmacs-deactivate-region Make the region between `point' and `mark' no longer be active, if `zmacs-regions' is true. You shouldn't need to call this; the command loop calls it when appropriate. Calling this function will call the hook `zmacs-deactivate-region-hook', if the region was previously active. Returns t if the region had been active, nil otherwise. Fzmacs-update-region Update the highlighted region between `point' and `mark'. You shouldn't need to call this; the command loop calls it when appropriate. Calling this function will call the hook `zmacs-update-region-hook', if the region is active. Vmessage-stack An alist of label/string pairs representing active echo-area messages. The first element in the list is currently displayed in the echo area. Do not modify this directly--use the `message' or `display-message'/`clear-message' functions. Vremove-message-hook A function or list of functions to be called when a message is removed from the echo area at the bottom of the frame. The label of the removed message is passed as the first argument, and the text of the message as the second argument. Vlog-message-max-size Maximum size of the " *Message-Log*" buffer. See `log-message'. Vlog-message-ignore-regexps List of regular expressions matching messages which shouldn't be logged. See `log-message'. Ideally, packages which generate messages which might need to be ignored should label them with 'progress, 'prompt, or 'no-log, so they can be filtered by the log-message-ignore-labels. Vlog-message-ignore-labels List of symbols indicating labels of messages which shouldn't be logged. See `display-message' for some common labels. See also `log-message'. Fshow-message-log Show the " *Message-Log*" buffer, which contains old messages and errors. Vlog-message-filter-function Value must be a function of two arguments: a symbol (label) and a string (messsage). It should return non-nil to indicate a message should be logged. Possible values include 'log-message-filter and 'log-message-filter-errors-only. Flog-message-filter Default value of log-message-filter-function. Mesages whose text matches one of the log-message-ignore-regexps or whose label appears in log-message-ignore-labels are not saved. Flog-message-filter-errors-only For use as the log-message-filter-function. Only logs error messages. Flog-message Stuff a copy of the message into the " *Message-Log*" buffer, if it satisfies the log-message-filter-function. For use on remove-message-hook. Fmessage-displayed-p Return a non-nil value if a message is presently displayed in the minibuffer's echo area. If optional argument RETURN-STRING is non-nil, return a string containing the message, otherwise just return t. Fclear-message Remove any message with the given LABEL from the message-stack, erasing it from the echo area if it's currently displayed there. If a message remains at the head of the message-stack and NO-RESTORE is nil, it will be displayed. The string which remains in the echo area will be returned, or nil if the message-stack is now empty. If LABEL is nil, the entire message-stack is cleared. Unless you need the return value or you need to specify a lable, you should just use (message nil). Fdisplay-message Print a one-line message at the bottom of the frame. First argument LABEL is an identifier for this message. MESSAGE is the string to display. Use `clear-message' to remove a labelled message. Here are some standard labels (those marked with `*' are not logged by default--see the `log-message-ignore-labels' variable): message default label used by the `message' function error default label used for reporting errors * progress progress indicators like "Converting... 45%" * prompt prompt-like messages like "I-search: foo" * no-log messages that should never be logged Fmessage Print a one-line message at the bottom of the frame. The arguments are the same as to `format'. If the only argument is nil, clear any existing message; let the minibuffer contents show. Vlog-warning-minimum-level Minimum level of warnings that should be logged. The warnings in levels below this are completely ignored, as if they never happened. The recognized warning levels, in decreasing order of priority, are 'emergency, 'alert, 'critical, 'error, 'warning, 'notice, 'info, and 'debug. See also `display-warning-minimum-level'. You can also control which warnings are displayed on a class-by-class basis. See `display-warning-suppressed-classes' and `log-warning-suppressed-classes'. Vdisplay-warning-minimum-level Minimum level of warnings that should be displayed. The warnings in levels below this are completely ignored, as if they never happened. The recognized warning levels, in decreasing order of priority, are 'emergency, 'alert, 'critical, 'error, 'warning, 'notice, 'info, and 'debug. See also `log-warning-minimum-level'. You can also control which warnings are displayed on a class-by-class basis. See `display-warning-suppressed-classes' and `log-warning-suppressed-classes'. Vlog-warning-suppressed-classes List of classes of warnings that shouldn't be logged or displayed. If any of the CLASS symbols associated with a warning is the same as any of the symbols listed here, the warning will be completely ignored, as it they never happened. NOTE: In most circumstances, you should *not* set this variable. Set `display-warning-suppressed-classes' instead. That way the suppressed warnings are not displayed but are still unobtrusively logged. See also `log-warning-minimum-level' and `display-warning-minimum-level'. Vdisplay-warning-suppressed-classes List of classes of warnings that shouldn't be displayed. If any of the CLASS symbols associated with a warning is the same as any of the symbols listed here, the warning will not be displayed. The warning will still logged in the *Warnings* buffer (unless also contained in `log-warning-suppressed-classes'), but the buffer will not be automatically popped up. See also `log-warning-minimum-level' and `display-warning-minimum-level'. Vwarning-count Count of the number of warning messages displayed so far. Fwarning-level-p Non-nil if LEVEL specifies a warning level. Fafter-init-display-warnings Display warnings deferred till after the init file is run. Warnings that occur before then are deferred so that warning suppression in the .emacs file will be honored. Fdisplay-warning Display a warning message. CLASS should be a symbol describing what sort of warning this is, such as `resource' or `key-mapping'. A list of such symbols is also accepted. (Individual classes can be suppressed; see `display-warning-suppressed-classes'.) Optional argument LEVEL can be used to specify a priority for the warning, other than default priority `warning'. (See `display-warning-minimum-level'). The message is inserted into the *Warnings* buffer, which is made visible at appropriate times. Fwarn Display a warning message. The message is constructed by passing all args to `format'. The message is placed in the *Warnings* buffer, which will be popped up at the next redisplay. The class of the warning is `warning'. See also `display-warning'. Fdisplay-warning-buffer Make the buffer that contains the warnings be visible. The C code calls this periodically, right before redisplay. Vhelp-map Keymap for characters following the Help key. Fhyperbole Hyperbole info manager menus. Ffinder-by-keyword Find packages matching a given keyword. Fhelp-with-tutorial Select the XEmacs learn-by-doing tutorial. Optional arg TUTORIAL specifies the tutorial file; default is "TUTORIAL". Fdescribe-key-briefly Print the name of the function KEY invokes. KEY is a string. Fprint-help-return-message Display or return message saying how to restore windows after help command. Computes a message and applies the optional argument FUNCTION to it. If FUNCTION is nil, applies `message' to it, thus printing it. Fdescribe-key Display documentation of the function invoked by KEY. KEY is a string, or vector of events. When called interactvely, KEY may also be a menu selection. Fdescribe-mode Display documentation of current major mode and minor modes. For this to work correctly for a minor mode, the mode's indicator variable (listed in `minor-mode-alist') must also be a function whose documentation describes the minor mode. Fdescribe-distribution Display info on how to obtain the latest version of XEmacs. Fdescribe-copying Display info on how you may redistribute copies of XEmacs. Fdescribe-pointer Show a list of all defined mouse buttons, and their definitions. This is the same as \[universal-argument] \[describe-bindings]. Fdescribe-no-warranty Display info on all the kinds of warranty XEmacs does NOT have. Fdescribe-bindings Show a list of all defined keys, and their definitions. The list is put in a buffer, which is displayed. If the optional argument PREFIX is supplied, only commands which start with that sequence of keys are described. If the second argument (prefix arg, interactively) is non-null then only the mouse bindings are displayed. Fdescribe-prefix-bindings Describe the bindings of the prefix used to reach this command. The prefix described consists of all but the last event of the key sequence that ran this command. Fxemacs-www-page Go to the XEmacs World Wide Web page. Fxemacs-www-faq View the latest and greatest XEmacs FAQ using the World Wide Web. Fxemacs-local-faq View the local copy of the XEmacs FAQ. If you have access to the World Wide Web, you should use `xemacs-www-faq' instead, to ensure that you get the most up-to-date information. Fview-emacs-news Display info on recent changes to XEmacs. Fview-lossage Display last 100 input keystrokes. Fhelp-for-help You have typed \[help-for-help], the help character. Type a Help option: (Use \<help-map>\[scroll-up] or \[scroll-down] to scroll through this text. Type \[help-quit] to exit the Help command.) \[hyper-apropos] Give a substring, and see a hypertext list of functions and variables that contain that substring. See also the `apropos' command. \[command-apropos] Give a substring, and see a list of commands (functions interactively callable) that contain that substring. \[describe-bindings] Display table of all key bindings. \[describe-key-briefly] Type a command key sequence; it prints the function name that sequence runs. \[describe-function] Type a function name and get documentation of it. \[Info-goto-emacs-command-node] Type a function name; it takes you to the Info node for that command. \[info] The info documentation reader. \[describe-key] Type a command key sequence; it displays the full documentation. \[Info-goto-emacs-key-command-node] Type a command key sequence; it takes you to the Info node for the command bound to that key. \[view-lossage] Shows last 100 characters you typed. \[describe-mode] Print documentation of current major mode, which describes the commands peculiar to it. \[view-emacs-news] Shows emacs news file. \[finder-by-keyword] Find packages matching a given topic keyword. \[describe-pointer] Display table of all mouse-button bindings. \[describe-syntax] Display contents of syntax table, plus explanations \[help-with-tutorial] Select the XEmacs learn-by-doing tutorial. \[describe-variable] Type name of a variable; it displays the variable's documentation and value. \[where-is] Type command name; it prints which keystrokes invoke that command. \[describe-copying] print XEmacs copying permission (General Public License). \[describe-distribution] XEmacs ordering information. \[view-emacs-news] print print news of recent XEmacs changes. \[describe-no-warranty] print information on absence of warranty for XEmacs. \[Info-query] Info reader, prompt for topic name. Vdescribe-function-show-arglist *If true, then describe-function will show its arglist if the function is not an autoload. Fdescribe-function Display the full documentation of FUNCTION (a symbol). Ffunction-obsoleteness-doc If FUNCTION is obsolete, return a string describing this. Fvariable-obsoleteness-doc If VARIABLE is obsolete, return a string describing this. Fdescribe-variable Display the full documentation of VARIABLE (a symbol). Fwhere-is Print message listing key sequences that invoke specified command. Argument is a command definition, usually a symbol with a function definition. Fcommand-apropos Like apropos but lists only symbols that are names of commands (interactively callable functions). Argument REGEXP is a regular expression that is matched against command symbol names. Returns list of symbols and documentation found. Flocate-library Show the full path name of XEmacs library LIBRARY. This command searches the directories in `load-path' like `M-x load-library' to find the file that `M-x load-library RET LIBRARY RET' would load. Optional second arg NOSUFFIX non-nil means don't add suffixes `.elc' or `.el' to the specified name LIBRARY (a la calling `load' instead of `load-library'). Fdescribe-syntax Describe the syntax specifications in the syntax table. The descriptions are inserted in a buffer, which is then displayed. Flist-processes Display a list of all processes. (Any processes listed as Exited or Signaled are actually eliminated after the listing is made.) Vmake-backup-files *Non-nil means make a backup of a file the first time it is saved. This can be done by renaming the file or by copying. Renaming means that XEmacs renames the existing file so that it is a backup file, then writes the buffer into a new file. Any other names that the old file had will now refer to the backup file. The new file is owned by you and its group is defaulted. Copying means that XEmacs copies the existing file into the backup file, then writes the buffer on top of the existing file. Any other names that the old file had will now refer to the new (edited) file. The file's owner and group are unchanged. The choice of renaming or copying is controlled by the variables `backup-by-copying', `backup-by-copying-when-linked' and `backup-by-copying-when-mismatch'. See also `backup-inhibited'. Vbackup-inhibited Non-nil means don't make a backup, regardless of the other parameters. This variable is intended for use by making it local to a buffer. But it is local only if you make it local. Vbackup-by-copying *Non-nil means always use copying to create backup files. See documentation of variable `make-backup-files'. Vbackup-by-copying-when-linked *Non-nil means use copying to create backups for files with multiple names. This causes the alternate names to refer to the latest version as edited. This variable is relevant only if `backup-by-copying' is nil. Vbackup-by-copying-when-mismatch *Non-nil means create backups by copying if this preserves owner or group. Renaming may still be used (subject to control of other variables) when it would not result in changing the owner or group of the file; that is, for files which are owned by you and whose group matches the default for a new file created there by you. This variable is relevant only if `backup-by-copying' is nil. Vbackup-enable-predicate Predicate that looks at a file name and decides whether to make backups. Called with an absolute file name as argument, it returns t to enable backup. Vbuffer-offer-save *Non-nil in a buffer means offer to save the buffer on exit even if the buffer is not visiting a file. Automatically local in all buffers. Vbuffer-file-number The device number and file number of the file visited in the current buffer. The value is a list of the form (FILENUM DEVNUM). This pair of numbers uniquely identifies the file. If the buffer is visiting a new file, the value is nil. Vfile-precious-flag *Non-nil means protect against I/O errors while saving files. Some modes set this non-nil in particular buffers. Vversion-control *Control use of version numbers for backup files. t means make numeric backup versions unconditionally. nil means make them for files that have some already. `never' means do not make them. Vdired-kept-versions *When cleaning directory, number of versions to keep. Vdelete-old-versions *If t, delete excess backup versions silently. If nil, ask confirmation. Any other value prevents any trimming. Vkept-old-versions *Number of oldest versions to keep when a new numbered backup is made. Vkept-new-versions *Number of newest versions to keep when a new numbered backup is made. Includes the new backup. Must be > 0 Vrequire-final-newline *Value of t says silently ensure a file ends in a newline when it is saved. Non-nil but not t says ask user whether to add a newline when there isn't one. nil means don't add newlines. Vauto-save-default *Non-nil says by default do auto-saving of every file-visiting buffer. Vauto-save-visited-file-name *Non-nil says auto-save a buffer in the file it is visiting, when practical. Normally auto-save files are written under other names. Vsave-abbrevs *Non-nil means save word abbrevs too when files are saved. Loading an abbrev file sets this to t. Vfind-file-run-dired *Non-nil says run dired if `find-file' is given the name of a directory. Vfind-file-not-found-hooks List of functions to be called for `find-file' on nonexistent file. These functions are called as soon as the error is detected. `buffer-file-name' is already set up. The functions are called in the order given until one of them returns non-nil. Vfind-file-hooks List of functions to be called after a buffer is loaded from a file. The buffer's local variables (if any) will have been processed before the functions are called. Vwrite-file-hooks List of functions to be called before writing out a buffer to a file. If one of them returns non-nil, the file is considered already written and the rest are not called. These hooks are considered to pertain to the visited file. So this list is cleared if you change the visited file name. See also `write-contents-hooks' and `continue-save-buffer'. Don't make this variable buffer-local; instead, use `local-write-file-hooks'. Vlocal-write-file-hooks Just like `write-file-hooks', except intended for per-buffer use. The functions in this list are called before the ones in `write-file-hooks'. Vafter-save-hook List of functions to be called after writing out a buffer to a file. These hooks are considered to pertain to the visited file. So this list is cleared if you change the visited file name. Vafter-set-visited-file-name-hooks List of functions to be called after \[set-visited-file-name] or during \[write-file]. You can use this hook to restore local values of write-file-hooks, after-write-file-hooks, and revert-buffer-function, which pertain to a specific file and therefore are normally killed by a rename. Put hooks pertaining to the buffer contents on write-contents-hooks and revert-buffer-insert-file-contents-function. Vwrite-contents-hooks List of functions to be called before writing out a buffer to a file. If one of them returns non-nil, the file is considered already written and the rest are not called. These hooks are considered to pertain to the buffer's contents, not to the particular visited file; thus, `set-visited-file-name' does not clear this variable, but changing the major mode does clear it. See also `write-file-hooks' and `continue-save-buffer'. Vwrite-file-data-hooks List of functions to be called to put the bytes on disk. These functions receive the name of the file to write to as argument. The default behavior is to call (write-region (point-min) (point-max) filename nil t) If one of them returns non-nil, the file is considered already written and the rest are not called. These hooks are considered to pertain to the visited file. So this list is cleared if you change the visited file name. See also `write-file-hooks'. Venable-local-variables *Control use of local-variables lists in files you visit. The value can be t, nil or something else. A value of t means local-variables lists are obeyed; nil means they are ignored; anything else means query. The command \[normal-mode] always obeys local-variables lists and ignores this variable. Venable-local-eval *Control processing of the "variable" `eval' in a file's local variables. The value can be t, nil or something else. A value of t means obey `eval' variables; nil means ignore them; anything else means query. The command \[normal-mode] always obeys local-variables lists and ignores this variable. Vhack-local-variables-hook List of functions to be called after local variables in a buffer have been processed. This hook runs even if there were no local variables or if their evaluation was suppressed. See also `enable-local-variables' and `enable-local-eval'. Fpwd Show the current default directory. Vcd-path Value of the CDPATH environment variable, as a list. Not actually set up until the first time you you use it. Fparse-colon-path Explode a colon-separated list of paths into a string list. Fcd-absolute Change current directory to given absolute file name DIR. Fcd Make DIR become the current buffer's default directory. If your environment includes a `CDPATH' variable, try each one of that colon-separated list of directories when resolving a relative directory name. Fload-file Load the Lisp file named FILE. Fload-library Load the library named LIBRARY. This is an interface to the function `load'. Ffind-library Find the library of Lisp code named LIBRARY. This searches `load-path' for a file named either "LIBRARY" or "LIBRARY.el". Ffile-local-copy Copy the file FILE into a temporary file on this machine. Returns the name of the local copy, or nil, if FILE is directly accessible. Ffile-chase-links Chase links in FILENAME until a name that is not a link. Does not examine containing directories for links, unlike `file-truename'. Fswitch-to-other-buffer Switch to the previous buffer. With a numeric arg, n, switch to the nth most recent buffer. With an arg of 0, buries the current buffer at the bottom of the buffer stack. Fswitch-to-buffer-other-window Select buffer BUFFER in another window. Fswitch-to-buffer-other-frame Switch to buffer BUFFER in a newly-created frame. Ffind-file Edit file FILENAME. Switch to a buffer visiting file FILENAME, creating one if none already exists. Ffind-file-other-window Edit file FILENAME, in another window. May create a new window, or reuse an existing one. See the function `display-buffer'. Ffind-file-other-frame Edit file FILENAME, in a newly-created frame. Ffind-file-read-only Edit file FILENAME but don't allow changes. Like \[find-file] but marks buffer as read-only. Use \[toggle-read-only] to permit editing. Ffind-file-read-only-other-window Edit file FILENAME in another window but don't allow changes. Like \[find-file-other-window] but marks buffer as read-only. Use \[toggle-read-only] to permit editing. Ffind-file-read-only-other-frame Edit file FILENAME in another frame but don't allow changes. Like \[find-file-other-frame] but marks buffer as read-only. Use \[toggle-read-only] to permit editing. Ffind-alternate-file Find file FILENAME, select its buffer, kill previous buffer. If the current buffer now contains an empty file that you just visited (presumably by mistake), use this command to visit the file you really want. Fcreate-file-buffer Create a suitably named buffer for visiting FILENAME, and return it. FILENAME (sans directory) is used unchanged if that name is free; otherwise a string <2> or <3> or ... is appended to get an unused name. Fgenerate-new-buffer Create and return a buffer with a name based on NAME. Choose the buffer's name using `generate-new-buffer-name'. Vfind-file-not-true-dirname-list *List of logical names for which visiting shouldn't save the true dirname. On VMS, when you visit a file using a logical name that searches a path, you may or may not want the visited file name to record the specific directory where the file was found. If you *do not* want that, add the logical name to this list as a string. Ffind-file-noselect Read file FILENAME into a buffer and return the buffer. If a buffer exists visiting FILENAME, return that one, but verify that the file has not changed since visited or saved. The buffer is not selected, just returned to the caller. If NOWARN is non-nil warning messages about several potential problems will be suppressed. Fafter-find-file Called after finding a file and by the default revert function. Sets buffer mode, parses local variables. Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an error in reading the file. WARN non-nil means warn if there exists an auto-save file more recent than the visited file. NOAUTO means don't mess with auto-save mode. Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil means this call was from `revert-buffer'. Finishes by calling the functions in `find-file-hooks'. Fnormal-mode Choose the major mode for this buffer automatically. Also sets up any specified local variables of the file. Uses the visited file name, the -*- line, and the local variables spec. This function is called automatically from `find-file'. In that case, we may set up specified local variables depending on the value of `enable-local-variables': if it is t, we do; if it is nil, we don't; otherwise, we query. `enable-local-variables' is ignored if you run `normal-mode' explicitly. Vauto-mode-alist Alist of filename patterns vs corresponding major mode functions. Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION). Visiting a file whose name matches REGEXP causes FUNCTION to be called. If the element has the form (REGEXP FUNCTION), then after calling FUNCTION, we delete the suffix that matched REGEXP and search the list again for another match. Vinterpreter-mode-alist Alist mapping interpreter names to major modes. This alist applies to files whose first line starts with `#!'. Each element looks like (INTERPRETER . MODE). The car of each element is compared with the name of the interpreter specified in the first line. If it matches, mode MODE is selected. Vinhibit-first-line-modes-regexps List of regexps; if one matches a file name, don't look for `-*-'. Vuser-init-file File name including directory of user's initialization file. Fset-auto-mode Select major mode appropriate for current buffer. This checks for a -*- mode tag in the buffer's text, compares the filename against the entries in `auto-mode-alist', or checks the interpreter that runs this file against `interpreter-mode-alist'. It does not check for the `mode:' local variable in the Local Variables section of the file; for that, use `hack-local-variables'. If `enable-local-variables' is nil, this function does not check for a -*- mode tag. Fhack-local-variables Parse, and bind or evaluate as appropriate, any local variables for current buffer. Vignored-local-variables Variables to be ignored in a file's local variable spec. Fset-visited-file-name Change name of file visited in current buffer to FILENAME. The next time the buffer is saved it will go in the newly specified file. nil or empty string as argument means make buffer not be visiting any file. Remember to delete the initial contents of the minibuffer if you wish to pass an empty string as the argument. Fwrite-file Write current buffer into file FILENAME. Makes buffer visit that file, and marks it not modified. If the buffer is already visiting a file, you can specify a directory name as FILENAME, to write a file of the same old name in that directory. Fbackup-buffer Make a backup of the disk file visited by the current buffer, if appropriate. This is normally done before saving the buffer the first time. If the value is non-nil, it is the result of `file-modes' on the original file; this means that the caller, after saving the buffer, should change the modes of the new file to agree with the old modes. Ffile-name-sans-versions Return FILENAME sans backup versions or strings. This is a separate procedure so your site-init or startup file can redefine it. If the optional argument KEEP-BACKUP-VERSION is non-nil, we do not remove backup version numbers, only true file version numbers. Fmake-backup-file-name Create the non-numeric backup file name for FILE. This is a separate function so you can redefine it for customization. Fbackup-file-name-p Return non-nil if FILE is a backup file name (numeric or not). This is a separate function so you can redefine it for customization. You may need to redefine `file-name-sans-versions' as well. Fbackup-extract-version Given the name of a numeric backup file, return the backup number. Uses the free variable `bv-length', whose value should be the index in the name where the version number begins. Ffind-backup-file-name Find a file name for a backup file, and suggestions for deletions. Value is a list whose car is the name for the backup file and whose cdr is a list of old versions to consider deleting now. Ffile-nlinks Return number of names file FILENAME has. Ffile-relative-name Convert FILENAME to be relative to DIRECTORY (default: default-directory). Fsave-buffer Save current buffer in visited file if modified. Versions described below. By default, makes the previous version into a backup file if previously requested or if this is the first save. With 1 or 3 \[universal-argument]'s, marks this version to become a backup when the next save is done. With 2 or 3 \[universal-argument]'s, unconditionally makes the previous version into a backup file. With argument of 0, never makes the previous version into a backup file. If a file's name is FOO, the names of its numbered backup versions are FOO.~i~ for various integers i. A non-numbered backup file is called FOO~. Numeric backups (rather than FOO~) will be made if value of `version-control' is not the atom `never' and either there are already numeric versions of the file being backed up, or `version-control' is non-nil. We don't want excessive versions piling up, so there are variables `kept-old-versions', which tells XEmacs how many oldest versions to keep, and `kept-new-versions', which tells how many newest versions to keep. Defaults are 2 old versions and 2 new. `dired-kept-versions' controls dired's clean-directory (.) command. If `delete-old-versions' is nil, system will query user before trimming versions. Otherwise it does it silently. Fdelete-auto-save-file-if-necessary Delete auto-save file for current buffer if `delete-auto-save-files' is t. Normally delete only if the file was written by this XEmacs since the last real save, but optional arg FORCE non-nil means delete anyway. Fbasic-save-buffer Save the current buffer in its visited file, if it has been modified. Fcontinue-save-buffer Provide a clean way for a write-file-hook to wrap AROUND the execution of the remaining hooks and writing to disk. Do not call this function except from a functions on the write-file-hooks or write-contents-hooks list. A hook that calls this function must return non-nil, to signal completion to its caller. continue-save-buffer always returns non-nil. Fsave-some-buffers Save some modified file-visiting buffers. Asks user about each one. Optional argument (the prefix) non-nil means save all with no questions. Optional second argument EXITING means ask about certain non-file buffers as well as about file buffers. Fnot-modified Mark current buffer as unmodified, not needing to be saved. With prefix arg, mark buffer as modified, so \[save-buffer] will save. Ftoggle-read-only Change whether this buffer is visiting its file read-only. With arg, set read-only iff arg is positive. Finsert-file Insert contents of file FILENAME into buffer after point. Set mark after the inserted text. This function is meant for the user to run interactively. Don't call it from programs! Use `insert-file-contents' instead. (Its calling sequence is different; see its documentation). Fappend-to-file Append the contents of the region to the end of file FILENAME. When called from a function, expects three arguments, START, END and FILENAME. START and END are buffer positions saying what text to write. Ffile-newest-backup Return most recent backup file for FILENAME or nil if no backups exist. Frename-uniquely Rename current buffer to a similar name not already taken. This function is useful for creating multiple shell process buffers or multiple mail buffers, etc. Fmake-directory-path Create all the directories along path that don't exist yet. Fmake-directory Create the directory DIR and any nonexistent parent dirs. Interactively, the default choice of directory to create is the current default directory for file names. That is useful when you have visited a file in a nonexistent directory. Noninteractively, the second (optional) argument PARENTS says whether to create parent directories if they don't exist. Vrevert-buffer-function Function to use to revert this buffer, or nil to do the default. The function receives two arguments IGNORE-AUTO and NOCONFIRM, which are the arguments that `revert-buffer' received. Vrevert-buffer-insert-file-contents-function Function to use to insert contents when reverting this buffer. Gets two args, first the nominal file name to use, and second, t if reading the auto-save file. Frevert-buffer Replace the buffer text with the text of the visited file on disk. This undoes all changes since the file was visited or saved. With a prefix argument, offer to revert from latest auto-save file, if that is more recent than the visited file. When called from lisp, the first argument is IGNORE-AUTO; only offer to revert from the auto-save file when this is nil. Note that the sense of this argument is the reverse of the prefix argument, for the sake of backward compatibility. IGNORE-AUTO is optional, defaulting to nil. Optional second argument NOCONFIRM means don't ask for confirmation at all. If the value of `revert-buffer-function' is non-nil, it is called to do the work. The default revert function runs the hook `before-revert-hook' at the beginning and `after-revert-hook' at the end. Frecover-file Visit file FILE, but get contents from its last auto-save file. Fkill-some-buffers For each buffer, ask whether to kill it. Fauto-save-mode Toggle auto-saving of contents of current buffer. With prefix argument ARG, turn auto-saving on if positive, else off. Frename-auto-save-file Adjust current buffer's auto save file name for current conditions. Also rename any existing auto save file, if it was made in this session. Fmake-auto-save-file-name Return file name to use for auto-saves of current buffer. Does not consider `auto-save-visited-file-name' as that variable is checked before calling this function. You can redefine this for customization. See also `auto-save-file-name-p'. Fauto-save-file-name-p Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'. FILENAME should lack slashes. You can redefine this for customization. Vlist-directory-brief-switches *Switches for list-directory to pass to `ls' for brief listing, Vlist-directory-verbose-switches *Switches for list-directory to pass to `ls' for verbose listing, Flist-directory Display a list of files in or matching DIRNAME, a la `ls'. DIRNAME is globbed by the shell if necessary. Prefix arg (second arg if noninteractive) means supply -l switch to `ls'. Actions controlled by variables `list-directory-brief-switches' and `list-directory-verbose-switches'. Vinsert-directory-program Absolute or relative name of the `ls' program used by `insert-directory'. Finsert-directory Insert directory listing for FILE, formatted according to SWITCHES. Leaves point after the inserted text. SWITCHES may be a string of options, or a list of strings. Optional third arg WILDCARD means treat FILE as shell wildcard. Optional fourth arg FULL-DIRECTORY-P means file is a directory and switches do not contain `d', so that a full listing is expected. This works by running a directory listing program whose name is in the variable `insert-directory-program'. If WILDCARD, it also runs the shell specified by `shell-file-name'. Vkill-emacs-query-functions Functions to call with no arguments to query about killing XEmacs. If any of these functions returns nil, killing XEmacs is cancelled. Fsave-buffers-kill-emacs Offer to save each buffer, then kill this XEmacs process. With prefix arg, silently save all file-visiting buffers, then kill. Fsymlink-expand-file-name If FILENAME is a symlink, return its non-symlink equivalent. Unlike `file-truename', this doesn't chase symlinks in directory components of the file or expand a relative pathname into an absolute one. Finsert-file-contents Insert contents of file FILENAME after point. Returns list of absolute file name and length of data inserted. If second argument VISIT is non-nil, the buffer's visited filename and last save file modtime are set, and it is marked unmodified. If visiting and the file does not exist, visiting is completed before the error is signaled. The optional third and fourth arguments BEG and END specify what portion of the file to insert. If VISIT is non-nil, BEG and END must be nil. If optional fifth argument REPLACE is non-nil, it means replace the current buffer contents (in the accessible portion) with the file contents. This is better than simply deleting and inserting the whole thing because (1) it preserves some marker positions and (2) it puts less data in the undo list. If support for Mule exists in this XEmacs, code conversion occurs according to the value of `input-coding-system', and `used-coding-system' is set to the coding system actually used. Currently BEG and END refer to byte positions (as opposed to character positions), even in Mule. Fwrite-region Write current region into specified file. When called from a program, takes three arguments: START, END and FILENAME. START and END are buffer positions. Optional fourth argument APPEND if non-nil means append to existing file contents (if any). Optional fifth argument VISIT if t means set the last-save-file-modtime of buffer to this file's modtime and mark buffer not modified. If VISIT is a string, it is a second file name; the output goes to FILENAME, but the buffer is marked as visiting VISIT. VISIT is also the file name to lock and unlock for clash detection. If VISIT is neither t nor nil nor a string, that means do not print the "Wrote file" message. Kludgy feature: if START is a string, then that string is written to the file, instead of any buffer contents, and END is ignored. If support for Mule exists in this XEmacs, code conversion occurs according to the value of `output-coding-system'. Fload Execute a file of Lisp code named FILE. First try FILE with `.elc' appended, then try with `.el', then try FILE unmodified. This function searches the directories in `load-path'. If optional second arg NOERROR is non-nil, report no error if FILE doesn't exist. Print messages at start and end of loading unless optional third arg NOMESSAGE is non-nil (ignored in -batch mode). If optional fourth arg NOSUFFIX is non-nil, don't try adding suffixes `.elc' or `.el' to the specified name FILE. Return t if file exists. Vindent-line-function Function to indent current line. Findent-according-to-mode Indent line in proper way for current major mode. Findent-for-tab-command Indent line in proper way for current major mode. Findent-rigidly Indent all lines starting in the region sideways by ARG columns. Called from a program, takes three arguments, START, END and ARG. Vindent-region-function Function which is short cut to indent region using indent-according-to-mode. A value of nil means really run indent-according-to-mode on each line. Findent-region Indent each nonblank line in the region. With no argument, indent each line using `indent-according-to-mode', or use `indent-region-function' to do the whole region if that's non-nil. If there is a fill prefix, make each line start with the fill prefix. With argument COLUMN, indent each line to that column. Called from a program, takes three args: START, END and COLUMN. Findent-relative-maybe Indent a new line like previous nonblank line. Findent-relative Space out to under next indent point in previous nonblank line. An indent point is a non-whitespace character following whitespace. If the previous nonblank line has no indent points beyond the column point starts at, `tab-to-tab-stop' is done instead. Vtab-stop-list *List of tab stop positions used by `tab-to-tab-stops'. This should be a list of integers, ordered from smallest to largest. Vedit-tab-stops-map Keymap used in `edit-tab-stops'. Vedit-tab-stops-buffer Buffer whose tab stops are being edited--in case the variable `tab-stop-list' is local in that buffer. Fedit-tab-stops Edit the tab stops used by `tab-to-tab-stop'. Creates a buffer *Tab Stops* containing text describing the tab stops. A colon indicates a column where there is a tab stop. You can add or remove colons and then do \<edit-tab-stops-map>\[edit-tab-stops-note-changes] to make changes take effect. Fedit-tab-stops-note-changes Put edited tab stops into effect. Ftab-to-tab-stop Insert spaces or tabs to next defined tab-stop column. The variable `tab-stop-list' is a list of columns at which there are tab stops. Use \[edit-tab-stops] to edit them interactively. Fmove-to-tab-stop Move point to next defined tab-stop column. The variable `tab-stop-list' is a list of columns at which there are tab stops. Use \[edit-tab-stops] to edit them interactively. Vselect-frame-hook Function or functions to run just after a new frame is given the focus. Note that calling `select-frame' does not necessarily set the focus: The actual window-system focus will not be changed until the next time that XEmacs is waiting for an event, and even then, the window manager may refuse the focus-change request. Vdeselect-frame-hook Function or functions to run just before a frame loses the focus. See `select-frame-hook'. Vinitial-frame-alist Alist of default values for the first frame. This may be set by the window-system-specific init file. Fget-other-frame Return some frame other than the current frame, creating one if necessary. Fnext-multiframe-window Select the next window, regardless of which frame it is on. Fprevious-multiframe-window Select the previous window, regardless of which frame it is on. Fframe-list Return a list of all frames on all devices. Ffiltered-frame-list Return a list of all live frames which satisfy PREDICATE. Fother-frame Select the ARG'th different visible frame, and raise it. All frames are arranged in a cyclic order. This command selects the frame ARG steps away in that order. A negative ARG moves in the opposite order. Fdevice-or-frame-p Return non-nil if OBJECT is a device or frame. Fdevice-or-frame-type Return the type (e.g. `x' or `tty') of DEVICE-OR-FRAME. DEVICE-OR-FRAME should be a device or a frame object. See `device-type' for a description of the possible types. Ficonify-emacs Replace every non-iconified FRAME with a *single* icon. Iconified frames are left alone. When XEmacs is in this globally-iconified state, de-iconifying any emacs icon will uniconify all frames that were visible, and iconify all frames that were not. Fsuspend-or-iconify-emacs Calls iconify-emacs if frame is an X frame, otherwise calls suspend-emacs Vauto-raise-frame *If true, frames will be raised to the top when selected. Under X, most ICCCM-compliant window managers will have an option to do this for you, but this variable is provided in case you're using a broken WM. Vauto-lower-frame *If true, frames will be lowered to the bottom when no longer selected. Under X, most ICCCM-compliant window managers will have an option to do this for you, but this variable is provided in case you're using a broken WM. Fdefault-select-frame-hook Implements the `auto-raise-frame' variable. For use as the value of `select-frame-hook'. Fdefault-deselect-frame-hook Implements the `auto-lower-frame' variable. For use as the value of `deselect-frame-hook'. Vget-frame-for-buffer-default-frame-name The default frame to select; see doc of `get-frame-for-buffer'. Fget-frame-for-buffer-noselect Return a frame in which to display BUFFER. This is a subroutine of `get-frame-for-buffer' (which see). Fget-frame-for-buffer Select and return a frame in which to display BUFFER. Normally, the buffer will simply be displayed in the current frame. But if the symbol naming the major-mode of the buffer has a 'frame-name property (which should be a symbol), then the buffer will be displayed in a frame of that name. If there is no frame of that name, then one is created. If the major-mode doesn't have a 'frame-name property, then the frame named by `get-frame-for-buffer-default-frame-name' will be used. If that is nil (the default) then the currently selected frame will used. If the frame-name symbol has an 'instance-limit property (an integer) then each time a buffer of the mode in question is displayed, a new frame with that name will be created, until there are `instance-limit' of them. If instance-limit is 0, then a new frame will be created each time. If a buffer is already displayed in a frame, then `instance-limit' is ignored, and that frame is used. If the frame-name symbol has a 'frame-defaults property, then that is prepended to the `default-frame-alist' when creating a frame for the first time. This function may be used as the value of `pre-display-buffer-function', to cause the display-buffer function and its callers to exhibit the above behavior. Fframes-of-buffer Return list of frames that BUFFER is currently being displayed on. If the buffer is being displayed on the currently selected frame, that frame is first in the list. VISIBLE-ONLY will only list non-iconified frames. Fshow-temp-buffer-in-current-frame For use as the value of temp-buffer-show-function: always displays the buffer in the current frame, regardless of the behavior that would otherwise be introduced by the `pre-display-buffer-function', which is normally set to `get-frame-for-buffer' (which see). Fdelete-other-frames Delete all but FRAME (or the selected frame). Vtoolbar-help-enabled If non-nil help is echoed for toolbar buttons. Vtoolbar-icon-directory Location of standard toolbar icon bitmaps. Ftoolbar-make-button-list Calls make-glyph on each arg and returns a list of the results. Fone-window-p Returns non-nil if the selected window is the only window (in its frame). Optional arg NOMINI non-nil means don't count the minibuffer even if it is active. The optional arg ALL-FRAMES t means count windows on all frames. If it is `visible', count windows on all visible frames. ALL-FRAMES nil or omitted means count only the selected frame, plus the minibuffer it uses (which may be on another frame). ALL-FRAMES = 0 means count windows on all visible and iconified frames. If ALL-FRAMES is any other value, count only the selected frame. Fwalk-windows Cycle through all visible windows, calling PROC for each one. PROC is called with a window as argument. Optional second arg MINIBUF t means count the minibuffer window even if not active. If MINIBUF is neither t nor nil it means not to count the minibuffer even if it is active. Optional third arg ALL-FRAMES t means include all windows in all frames; otherwise cycle within the selected frame. Fcount-windows Returns the number of visible windows. Optional arg NO-MINI non-nil means don't count the minibuffer even if it is active. Fbalance-windows Makes all visible windows the same height (approximately). Vsplit-window-keep-point *If non-nil, split windows keeps the original point in both children. This is often more convenient for editing. If nil, adjust point in each of the two windows to minimize redisplay. This is convenient on slow terminals, but point can move strangely. Fsplit-window-vertically Split current window into two windows, one above the other. The uppermost window gets ARG lines and the other gets the rest. Negative arg means select the size of the lowermost window instead. With no argument, split equally or close to it. Both windows display the same buffer now current. If the variable split-window-keep-point is non-nil, both new windows will get the same value of point as the current window. This is often more convenient for editing. Otherwise, we chose window starts so as to minimize the amount of redisplay; this is convenient on slow terminals. The new selected window is the one that the current value of point appears in. The value of point can change if the text around point is hidden by the new modeline. Programs should probably use split-window instead of this. Fsplit-window-horizontally Split current window into two windows side by side. This window becomes the leftmost of the two, and gets ARG columns. Negative arg means select the size of the rightmost window instead. No arg means split equally. Fenlarge-window-horizontally Make current window ARG columns wider. Fshrink-window-horizontally Make current window ARG columns narrower. Fshrink-window-if-larger-than-buffer Shrink the WINDOW to be as small as possible to display its contents. Do not shrink to less than `window-min-height' lines. Do nothing if the buffer contains more lines than the present window height, or if some of the window's contents are scrolled out of view, or if the window is not the full width of the frame, or if the window is the only window of its frame. Fbackward-other-window Select the ARG'th different window on this frame, going backwards. This is just like calling `other-window' with the arg negated. Fwindows-of-buffer Returns a list of windows that have BUFFER in them. If BUFFER is not specified, the current buffer will be used. Fbuffer-in-multiple-windows-p Returns t if BUFFER is in multiple windows. If BUFFER is not specified, the current buffer will be used. Fwindow-list Return a list of windows on FRAME, beginning with WINDOW. FRAME and WINDOW default to the selected ones. Optional second arg MINIBUF t means count the minibuffer window even if not active. If MINIBUF is neither t nor nil it means not to count the minibuffer even if it is active. Fset-window-dedicated-p Control whether WINDOW is dedicated to the buffer it displays. If it is dedicated, Emacs will not automatically change which buffer appears in it. The second argument is the new value for the dedication flag; non-nil means yes. Fcommand-line-do-help Print this message and exit. Vdirectory-abbrev-alist *Alist of abbreviations for file directories. A list of elements of the form (FROM . TO), each meaning to replace FROM with TO when it appears in a directory name. This replacement is done when setting up the default directory of a newly visited file. *Every* FROM string should start with \\` or ^. Use this feature when you have directories which you normally refer to via absolute symbolic links or to eliminate automounter mount points from the beginning of your filenames. Make TO the name of the link, and FROM the name it is linked to. Vabbreviated-home-dir The user's homedir abbreviated according to `directory-abbrev-alist'. Fabbreviate-file-name Return a version of FILENAME shortened using `directory-abbrev-alist'. See \[describe-variable] directory-abbrev-alist RET for more information. If optional argument HACK-HOMEDIR is non-nil, then This also substitutes "~" for the user's home directory. Vcommand-line-processed t once command line has been processed Vinhibit-startup-message *Non-nil inhibits the initial startup message. This is for use in your personal init file, once you are familiar with the contents of the startup message. Vinhibit-default-init *Non-nil inhibits loading the `default' library. Vcommand-switch-alist Alist of command-line switches. Elements look like (SWITCH-STRING . HANDLER-FUNCTION). HANDLER-FUNCTION receives switch name as sole arg; remaining command-line args are in the variable `command-line-args-left'. Vcommand-line-args-left List of command-line args not yet processed. Vcommand-line-default-directory Default directory to use for command line arguments. This is normally copied from `default-directory' when XEmacs starts. Vbefore-init-hook Functions to call after handling urgent options but before init files. The frame system uses this to open frames to display messages while Emacs loads the user's initialization file. Vafter-init-hook Functions to call after loading the init file (`~/.emacs'). The call is not protected by a condition-case, so you can set `debug-on-error' in `.emacs', and put all the actual code on `after-init-hook'. Vterm-setup-hook Functions to be called after loading terminal-specific Lisp code. See `run-hooks'. This variable exists for users to set, so as to override the definitions made by the terminal-specific file. Emacs never sets this variable itself. Vkeyboard-type The brand of keyboard you are using. This variable is used to define the proper function and keypad keys for use under X. It is used in a fashion analogous to the environment value TERM. Vwindow-setup-hook Normal hook run to initialize window system display. Emacs runs this hook after processing the command line arguments and loading the user's init file. Vinitial-major-mode Major mode command symbol to use for the initial *scratch* buffer. Vinit-file-user Identity of user whose `.emacs' file is or was read. The value is nil if no init file is being used; otherwise, it may be either the null string, meaning that the init file was taken from the user that originally logged in, or it may be a string containing a user's name. In either of the latter cases, `(concat "~" init-file-user "/")' evaluates to the name of the directory where the `.emacs' file was looked for. Vsite-start-file File containing site-wide run-time initializations. This file is loaded at run-time before `~/.emacs'. It contains inits that need to be in place for the entire site, but which, due to their higher incidence of change, don't make sense to load into emacs' dumped image. Thus, the run-time load order is: 1. file described in this variable, if non-nil; 2. `~/.emacs'; 3. `default.el'. Vuser-mail-address Full mailing address of this user. Vinit-file-loaded True after the user's init file has been loaded (or suppressed with -q). This will be true when `after-init-hook' is run and at all times after, and will not be true at any time before. Fcommand-line-do-funcall Invoke the named lisp function with no arguments. <function> Fcommand-line-do-eval Evaluate the lisp form. Quote it carefully. <form> Fcommand-line-do-load Load the named file of Lisp code into XEmacs. <file> Fcommand-line-do-insert Insert file into the current buffer. <file> Fcommand-line-do-kill Exit XEmacs. Fcommand-line-do-version Print version info and exit. Fearly-error-handler You should probably not be using this. Vstartup-presentation-hack-keymap Putting yesterday in the future tomorrow. Vdefun-prompt-regexp *Non-nil => regexp to ignore, before the character that starts a defun. This is only necessary if the opening paren or brace is not in column 0. See `beginning-of-defun'. Vparens-require-spaces Non-nil => `insert-parentheses' should insert whitespace as needed. Fforward-sexp Move forward across one balanced expression (sexp). With argument, do it that many times. Negative arg -N means move backward across N balanced expressions. Fbackward-sexp Move backward across one balanced expression (sexp). With argument, do it that many times. Negative arg -N means move forward across N balanced expressions. Fmark-sexp Set mark ARG sexps from point. The place mark goes is the same place \[forward-sexp] would move to with the same argument. Repeat this command to mark more sexps in the same direction. Fforward-list Move forward across one balanced group of parentheses. With argument, do it that many times. Negative arg -N means move backward across N groups of parentheses. Fbackward-list Move backward across one balanced group of parentheses. With argument, do it that many times. Negative arg -N means move forward across N groups of parentheses. Fdown-list Move forward down one level of parentheses. With argument, do this that many times. A negative argument means move backward but still go down a level. In Lisp programs, an argument is required. Fbackward-up-list Move backward out of one level of parentheses. With argument, do this that many times. A negative argument means move forward but still to a less deep spot. In Lisp programs, an argument is required. Fup-list Move forward out of one level of parentheses. With argument, do this that many times. A negative argument means move backward but still to a less deep spot. In Lisp programs, an argument is required. Fkill-sexp Kill the sexp (balanced expression) following the cursor. With argument, kill that many sexps after the cursor. Negative arg -N means kill N sexps before the cursor. Fbackward-kill-sexp Kill the sexp (balanced expression) preceding the cursor. With argument, kill that many sexps before the cursor. Negative arg -N means kill N sexps after the cursor. Fbeginning-of-defun Move backward to the beginning of a defun. With argument, do it that many times. Negative arg -N means move forward to Nth following beginning of defun. Returns t unless search stops due to beginning or end of buffer. Normally a defun starts when there is an char with open-parenthesis syntax at the beginning of a line. If `defun-prompt-regexp' is non-nil, then a string which matches that regexp may precede the open-parenthesis, and point ends up at the beginning of the line. Fbeginning-of-defun-raw Move point to the character that starts a defun. This is identical to beginning-of-defun, except that point does not move to the beginning of the line when `defun-prompt-regexp' is non-nil. Fend-of-defun Move forward to next end of defun. With argument, do it that many times. Negative argument -N means move back to Nth preceding end of defun. An end of a defun occurs right after the close-parenthesis that matches the open-parenthesis that starts a defun; see `beginning-of-defun'. Fmark-defun Put mark at end of this defun, point at beginning. The defun marked is the one that contains point or follows point. Finsert-parentheses Put parentheses around next ARG sexps. Leave point after open-paren. No argument is equivalent to zero: just insert `()' and leave point between. If `parens-require-spaces' is non-nil, this command also inserts a space before and after, depending on the surrounding characters. Fmove-past-close-and-reindent Move past next `)', delete indentation before it, then indent after it. Flisp-complete-symbol Perform completion on Lisp symbol preceding point. That symbol is compared against the symbols that exist and any additional characters determined by what is there are inserted. If the symbol starts just after an open-parenthesis, only symbols with function definitions are considered. Otherwise, all symbols with function definitions, values or properties are considered. Fforward-page Move forward to page boundary. With arg, repeat, or go back if negative. A page boundary is any line whose beginning matches the regexp `page-delimiter'. Fbackward-page Move backward to page boundary. With arg, repeat, or go fwd if negative. A page boundary is any line whose beginning matches the regexp `page-delimiter'. Fmark-page Put mark at end of page, point at beginning. A numeric arg specifies to move forward or backward by that many pages, thus marking a page other than the one point was originally in. Fnarrow-to-page Make text outside current page invisible. A numeric arg specifies to move forward or backward by that many pages, thus showing a page other than the one point was originally in. Fcount-lines-page Report number of lines on current page, and how many are before or after point. Fwhat-page Print page and line number of point. Vregister-alist Alist of elements (NAME . CONTENTS), one for each Emacs register. NAME is a character (a number). CONTENTS is a string, number, frame configuration, mark or list. A list of strings represents a rectangle. A list of the form (file . NAME) represents the file named NAME. Fget-register Return contents of Emacs register named CHAR, or nil if none. Fset-register Set contents of Emacs register named CHAR to VALUE. Returns VALUE. See the documentation of the variable `register-alist' for possible VALUEs. Fpoint-to-register Store current location of point in register REGISTER. Argument is a character, naming the register. Fwindow-configuration-to-register Store the window configuration of the selected frame in register REGISTER. Use \[jump-to-register] to restore the configuration. Argument is a character, naming the register. Fjump-to-register Move point to location stored in a register. If the register contains a file name, find that file. (To put a file name in a register, you must use `set-register'.) If the register contains a window configuration (one frame) or a frame configuration (all frames), restore that frame or all frames accordingly. Argument is a character, naming the register. Fview-register Display what is contained in register named REGISTER. REGISTER is a character. Finsert-register Insert contents of register REG. REG is a character. Normally puts point before and mark after the inserted text. If optional second arg is non-nil, puts mark before and point after. Interactively, second arg is non-nil if prefix arg is supplied. Fcopy-to-register Copy region into register REG. With prefix arg, delete as well. Called from program, takes four args: REG, START, END and DELETE-FLAG. START and END are buffer positions indicating what to copy. Fappend-to-register Append region to text in register REG. With prefix arg, delete as well. Called from program, takes four args: REG, START, END and DELETE-FLAG. START and END are buffer positions indicating what to append. Fprepend-to-register Prepend region to text in register REG. With prefix arg, delete as well. Called from program, takes four args: REG, START, END and DELETE-FLAG. START and END are buffer positions indicating what to prepend. Fcopy-rectangle-to-register Copy rectangular region into register REG. With prefix arg, delete as well. Called from program, takes four args: REG, START, END and DELETE-FLAG. START and END are buffer positions giving two corners of rectangle. Viso8859/1-case-table The case table for ISO-8859/1 characters. Vparagraph-start *Regexp for beginning of a line that starts OR separates paragraphs. This regexp should match lines that separate paragraphs and should also match lines that start a paragraph (and are part of that paragraph). The variable `paragraph-separate' specifies how to distinguish lines that start paragraphs from lines that separate them. Vparagraph-separate *Regexp for beginning of a line that separates paragraphs. If you change this, you may have to change paragraph-start also. Vsentence-end *Regexp describing the end of a sentence. All paragraph boundaries also end sentences, regardless. In order to be recognized as the end of a sentence, the ending period, question mark, or exclamation point must be followed by two spaces, unless it's inside some sort of quotes or parenthesis. Vpage-delimiter *Regexp describing line-beginnings that separate pages. Vparagraph-ignore-fill-prefix Non-nil means the paragraph commands are not affected by `fill-prefix'. This is desirable in modes where blank lines are the paragraph delimiters. Fforward-paragraph Move forward to end of paragraph. With arg N, do it N times; negative arg -N means move backward N paragraphs. A line which `paragraph-start' matches either separates paragraphs (if `paragraph-separate' matches it also) or is the first line of a paragraph. A paragraph end is the beginning of a line which is not part of the paragraph to which the end of the previous line belongs, or the end of the buffer. Fbackward-paragraph Move backward to start of paragraph. With arg N, do it N times; negative arg -N means move forward N paragraphs. A paragraph start is the beginning of a line which is a `first-line-of-paragraph' or which is ordinary text and follows a paragraph-separating line; except: if the first real line of a paragraph is preceded by a blank line, the paragraph starts at that blank line. See `forward-paragraph' for more information. Fmark-paragraph Put point at beginning of this paragraph, mark at end. The paragraph marked is the one that contains point or follows point. Fkill-paragraph Kill forward to end of paragraph. With arg N, kill forward to Nth end of paragraph; negative arg -N means kill backward to Nth start of paragraph. Fbackward-kill-paragraph Kill back to start of paragraph. With arg N, kill back to Nth start of paragraph; negative arg -N means kill forward to Nth end of paragraph. Ftranspose-paragraphs Interchange this (or next) paragraph with previous one. Fforward-sentence Move forward to next `sentence-end'. With argument, repeat. With negative argument, move backward repeatedly to `sentence-beginning'. The variable `sentence-end' is a regular expression that matches ends of sentences. Also, every paragraph boundary terminates sentences as well. Fbackward-sentence Move backward to start of sentence. With arg, do it arg times. See `forward-sentence' for more information. Fkill-sentence Kill from point to end of sentence. With arg, repeat; negative arg -N means kill back to Nth start of sentence. Fbackward-kill-sentence Kill back from point to start of sentence. With arg, repeat, or kill forward to Nth end of sentence if negative arg -N. Fmark-end-of-sentence Put mark at end of sentence. Arg works as in `forward-sentence'. Ftranspose-sentences Interchange this (next) and previous sentence. Vlisp-mode-syntax-table Vemacs-lisp-mode-syntax-table Vlisp-mode-abbrev-table Vshared-lisp-mode-map Keymap for commands shared by all sorts of Lisp modes. Vemacs-lisp-mode-map Keymap for Emacs Lisp mode. All commands in shared-lisp-mode-map are inherited by this map. Femacs-lisp-mode Major mode for editing Lisp code to run in Emacs. Commands: Delete converts tabs to spaces as it moves back. Blank lines separate paragraphs. Semicolons start comments. \{emacs-lisp-mode-map} Entry to this mode calls the value of `emacs-lisp-mode-hook' if that value is non-nil. Vlisp-mode-map Keymap for ordinary Lisp mode. All commands in `shared-lisp-mode-map' are inherited by this map. Flisp-mode Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp. Commands: Delete converts tabs to spaces as it moves back. Blank lines separate paragraphs. Semicolons start comments. \{lisp-mode-map} Note that `run-lisp' may be used either to start an inferior Lisp job or to switch back to an existing one. Entry to this mode calls the value of `lisp-mode-hook' if that value is non-nil. Flisp-send-defun Send the current defun to the Lisp process made by \[run-lisp]. Vlisp-interaction-mode-map Keymap for Lisp Interaction moe. All commands in `emacs-lisp-mode-map' are inherited by this map. Flisp-interaction-mode Major mode for typing and evaluating Lisp forms. Like Lisp mode except that \[eval-print-last-sexp] evals the Lisp expression before point, and prints its value into the buffer, advancing point. Commands: Delete converts tabs to spaces as it moves back. Paragraphs are separated only by blank lines. Semicolons start comments. \{lisp-interaction-mode-map} Entry to this mode calls the value of `lisp-interaction-mode-hook' if that value is non-nil. Feval-print-last-sexp Evaluate sexp before point; print value into current buffer. Feval-interactive Like `eval' except that it transforms defvars to defconsts. Feval-last-sexp Evaluate sexp before point; print value in minibuffer. With argument, print output into current buffer. Feval-defun Evaluate defun that point is in or before. Print value in minibuffer. With argument, insert value in current buffer after the defun. Flisp-indent-for-comment Indent this line's comment appropriately, or insert an empty comment. If adding a new comment on a blank line, use `block-comment-start' instead of `comment-start' to open the comment. Vlisp-indent-offset Vlisp-indent-function Flisp-indent-line Indent current line as Lisp code. With argument, indent any additional lines of the same expression rigidly along with this one. Fcalculate-lisp-indent Return appropriate indentation for current line as Lisp code. In usual case returns an integer: the column to indent to. Can instead return a list, whose car is the column to indent to. This means that following lines at the same level of indentation should not necessarily be indented the same way. The second element of the list is the buffer position of the start of the containing expression. Vlisp-body-indent Number of columns to indent the second line of a `(def...)' form. Findent-sexp Indent each line of the list starting just after point. If optional arg ENDPOS is given, indent each line, stopping when ENDPOS is encountered. Flisp-fill-paragraph Like \[fill-paragraph], but handle Emacs Lisp comments. If any of the current line is a comment, fill the comment or the paragraph of it that point is in, preserving the comment's indentation and initial semicolons. Findent-code-rigidly Indent all lines of code, starting in the region, sideways by ARG columns. Does not affect lines starting inside comments or strings, assuming that the start of the region is not inside them. Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP. The last is a regexp which, if matched at the beginning of a line, means don't indent that line. Vtext-mode-syntax-table Syntax table used while in text mode. Vtext-mode-abbrev-table Abbrev table used while in text mode. Vtext-mode-map Keymap for Text mode. Many other modes, such as Mail mode, Outline mode and Indented Text mode, inherit all the commands defined in this map. Ftext-mode Major mode for editing text intended for humans to read. Special commands:\{text-mode-map} Turning on Text mode calls the value of the variable `text-mode-hook', if that value is non-nil. Vindented-text-mode-map Keymap for Indented Text mode. All the commands defined in Text mode are inherited unless overridden. Findented-text-mode Major mode for editing text with indented paragraphs. In this mode, paragraphs are delimited only by blank lines. You can thus get the benefit of adaptive filling (see the variable `adaptive-fill-mode'). \{indented-text-mode-map} Turning on `indented-text-mode' calls the value of the variable `text-mode-hook', if that value is non-nil. Fcenter-paragraph Center each nonblank line in the paragraph at or after point. See `center-line' for more info. Fcenter-region Center each nonblank line starting in the region. See `center-line' for more info. Fcenter-line Center the line point is on, within the width specified by `fill-column'. This means adjusting the indentation so that it equals the distance between the end of the text and `fill-column'. Vfill-individual-varying-indent *Controls criterion for a new paragraph in `fill-individual-paragraphs'. Non-nil means changing indent doesn't end a paragraph. That mode can handle paragraphs with extra indentation on the first line, but it requires separator lines between paragraphs. A value of nil means that any change in indentation starts a new paragraph. Vsentence-end-double-space *Non-nil means a single space does not end a sentence. Fset-fill-prefix Set the fill prefix to the current line up to point. Filling expects lines to start with the fill prefix and reinserts the fill prefix in each resulting line. Vadaptive-fill-mode *Non-nil means determine a paragraph's fill prefix from its text. Vadaptive-fill-regexp *Regexp to match text at start of line that constitutes indentation. If Adaptive Fill mode is enabled, whatever text matches this pattern on the second line of a paragraph is used as the standard indentation for the paragraph. Ffill-region-as-paragraph Fill region as one paragraph: break lines to fit `fill-column'. Prefix arg means justify too. If `sentence-end-double-space' is non-nil, then period followed by one space does not end a sentence, so don't break a line there. From program, pass args FROM, TO and JUSTIFY-FLAG. Ffill-paragraph Fill paragraph at or after point. Prefix arg means justify as well. If `sentence-end-double-space' is non-nil, then period followed by one space does not end a sentence, so don't break a line there. Ffill-region Fill each of the paragraphs in the region. Prefix arg (non-nil third arg, if called from program) means justify as well. If `sentence-end-double-space' is non-nil, then period followed by one space does not end a sentence, so don't break a line there. Ffill-paragraph-or-region Fill the current region, if it's active; otherwise, fill the paragraph. See `fill-paragraph' and `fill-region' for more information. Fjustify-current-line Add spaces to line point is in, so it ends at `fill-column'. Ffill-nonuniform-paragraphs Fill paragraphs within the region, allowing varying indentation within each. This command divides the region into "paragraphs", only at paragraph-separator lines, then fills each paragraph using as the fill prefix the smallest indentation of any line in the paragraph. When calling from a program, pass range to fill as first two arguments. Optional third and fourth arguments JUSTIFY-FLAG and MAIL-FLAG: JUSTIFY-FLAG to justify paragraphs (prefix arg), MAIL-FLAG for a mail message, i. e. don't fill header lines. Ffill-individual-paragraphs Fill paragraphs of uniform indentation within the region. This command divides the region into "paragraphs", treating every change in indentation level as a paragraph boundary, then fills each paragraph using its indentation level as the fill prefix. When calling from a program, pass range to fill as first two arguments. Optional third and fourth arguments JUSTIFY-FLAG and MAIL-FLAG: JUSTIFY-FLAG to justify paragraphs (prefix arg), MAIL-FLAG for a mail message, i. e. don't fill header lines. Vsearch-last-string Last string search for by a search command. This does not include direct calls to the primitive search functions, and does not include searches that are aborted. Vsearch-last-regexp Last string searched for by a regexp search command. This does not include direct calls to the primitive search functions, and does not include searches that are aborted. Vsearch-exit-option Non-nil means random control characters terminate incremental search. Vsearch-slow-window-lines *Number of lines in slow search display windows. These are the short windows used during incremental search on slow terminals. Negative means put the slow search window at the top (normally it's at bottom) and the value is minus the number of lines. Vsearch-slow-speed *Highest terminal speed at which to use "slow" style incremental search. This is the style where a one-line window is created to show the line that the search has reached. Vsearch-caps-disable-folding *If non-nil, upper case chars disable case fold searching. This does not apply to "yanked" strings. Vsearch-nonincremental-instead *If non-nil, do a nonincremental search instead if exiting immediately. Vsearch-whitespace-regexp *If non-nil, regular expression to match a sequence of whitespace chars. Vsearch-ring List of search string sequences. Vregexp-search-ring List of regular expression search string sequences. Vsearch-ring-max *Maximum length of search ring before oldest elements are thrown away. Vregexp-search-ring-max *Maximum length of regexp search ring before oldest elements are thrown away. Vsearch-ring-yank-pointer The tail of the search ring whose car is the last thing searched for. Vregexp-search-ring-yank-pointer The tail of the regular expression search ring whose car is the last thing searched for. Visearch-mode-map Keymap for isearch-mode. Vminibuffer-local-isearch-map Keymap for editing isearch strings in the minibuffer. Visearch-mode-hook Function(s) to call after starting up an incremental search. Visearch-mode-end-hook Function(s) to call after terminating an incremental search. Fisearch-forward Do incremental search forward. With a prefix argument, do an incremental regular expression search instead. \<isearch-mode-map> As you type characters, they add to the search string and are found. The following non-printing keys are bound in `isearch-mode-map'. Type \[isearch-delete-char] to cancel characters from end of search string. Type \[isearch-exit] to exit, leaving point at location found. Type LFD (C-j) to match end of line. Type \[isearch-repeat-forward] to search again forward, \[isearch-repeat-backward] to search again backward. Type \[isearch-yank-word] to yank word from buffer onto end of search string and search for it. Type \[isearch-yank-line] to yank rest of line onto end of search string and search for it. Type \[isearch-quote-char] to quote control character to search for it. Type \[isearch-whitespace-chars] to match all whitespace chars in regexp. \[isearch-abort] while searching or when search has failed cancels input back to what has been found successfully. \[isearch-abort] when search is successful aborts and moves point to starting point. Also supported is a search ring of the previous 16 search strings. Type \[isearch-ring-advance] to search for the next item in the search ring. Type \[isearch-ring-retreat] to search for the previous item in the search ring. Type \[isearch-complete] to complete the search string using the search ring. The above keys are bound in the isearch-mode-map. To change the keys which are special to isearch-mode, simply change the bindings in that map. Other control and meta characters terminate the search and are then executed normally (depending on `search-exit-option'). If this function is called non-interactively, it does not return to the calling function until the search is done. The bindings, more precisely: \{isearch-mode-map} Fisearch-forward-regexp Do incremental search forward for regular expression. Like ordinary incremental search except that your input is treated as a regexp. See \[isearch-forward] for more info. Fisearch-backward Do incremental search backward. With a prefix argument, do an incremental regular expression search instead. See \[isearch-forward] for more information. Fisearch-backward-regexp Do incremental search backward for regular expression. Like ordinary incremental search except that your input is treated as a regexp. See \[isearch-forward] for more info. Fisearch-mode Start isearch minor mode. Called by isearch-forward, etc. Fisearch-exit Exit search normally. However, if this is the first command after starting incremental search and `search-nonincremental-instead' is non-nil, do an incremental search via `isearch-edit-string'. Fisearch-edit-string Edit the search string in the minibuffer. The following additional command keys are active while editing. \<minibuffer-local-isearch-map> \[exit-minibuffer] to exit editing and resume incremental searching. \[isearch-forward-exit-minibuffer] to resume isearching forward. \[isearch-backward-exit-minibuffer] to resume isearching backward. \[isearch-ring-advance-edit] to replace the search string with the next item in the search ring. \[isearch-ring-retreat-edit] to replace the search string with the next item in the search ring. \[isearch-complete-edit] to complete the search string from the search ring. Fisearch-abort Quit incremental search mode if searching is successful, signalling quit. Otherwise, revert to previous successful search and continue searching. Use `isearch-exit' to quit without signalling. Fisearch-repeat-forward Repeat incremental search forwards. Fisearch-repeat-backward Repeat incremental search backwards. Fisearch-toggle-regexp Toggle regexp searching on or off. Fisearch-delete-char Discard last input item and move point back. If no previous match was done, just beep. Fisearch-yank-word Pull next word from buffer into search string. Fisearch-yank-line Pull rest of line from buffer into search string. Fisearch-yank-sexp Pull next expression from buffer into search string. Fisearch-yank-x-selection Pull the current X selection into the search string. Fisearch-yank-x-clipboard Pull the current X clipboard selection into the search string. Fisearch-*-char Handle * and ? specially in regexps. Fisearch-|-char If in regexp search, jump to the barrier. Fisearch-quote-char Quote special characters for incremental search. Fisearch-return-char Convert return into newline for incremental search. Obsolete. Fisearch-printing-char Any other printing character => add it to the search string and search. Fisearch-whitespace-chars Match all whitespace chars, if in regexp mode. Vsearch-ring-update *Non-nil if advancing or retreating in the search ring should cause search. Default nil means edit the string from the search ring first. Fisearch-ring-advance Advance to the next search string in the ring. Fisearch-ring-retreat Retreat to the previous search string in the ring. Fisearch-ring-adjust-edit Use the next or previous search string in the ring while in minibuffer. Fisearch-ring-retreat-edit Retreat to the previous search string in the ring while in the minibuffer. Fisearch-complete Complete the search string from the strings on the search ring. The completed string is then editable in the minibuffer. If there is no completion possible, say so and continue searching. Fisearch-complete-edit Same as `isearch-complete' except in the minibuffer. Visearch-highlight *Whether isearch and query-replace should highlight the text which currently matches the search-string. Fisearch-no-upper-case-p Return t if there are no upper case chars in string. But upper case chars preceeded by \ do not count since they have special meaning in a regexp. Fcopy-from-above-command Copy characters from previous nonblank line, starting just above point. Copy ARG characters, but not past the end of that line. If no argument given, copy the entire rest of the line. The characters copied are inserted in the buffer before point. Fadd-minor-mode Add a minor mode to `minor-mode-alist' and `minor-mode-map-alist'. TOGGLE is a symbol which is used as the variable which toggle the minor mode, NAME is the name that should appear in the modeline (it should be a string beginning with a space), KEYMAP is a keymap to make active when the minor mode is active, and AFTER is the toggling symbol used for another minor mode. If AFTER is non-nil, then it is used to position the new mode in the minor-mode alists. Example: (add-minor-mode 'view-minor-mode " View" view-mode-map) Vc-inhibit-startup-warnings-p *If non-nil, inhibits start up compatibility warnings. Vc-strict-syntax-p *If non-nil, all syntactic symbols must be found in `c-offsets-alist'. If the syntactic symbol for a particular line does not match a symbol in the offsets alist, an error is generated, otherwise no error is reported and the syntactic symbol is ignored. Vc-echo-syntactic-information-p *If non-nil, syntactic info is echoed when the line is indented. Vc-basic-offset *Amount of basic offset used by + and - symbols in `c-offsets-alist'. Vc-offsets-alist *Association list of syntactic element symbols and indentation offsets. As described below, each cons cell in this list has the form: (SYNTACTIC-SYMBOL . OFFSET) When a line is indented, cc-mode first determines the syntactic context of the line by generating a list of symbols called syntactic elements. This list can contain more than one syntactic element and the global variable `c-syntactic-context' contains the context list for the line being indented. Each element in this list is actually a cons cell of the syntactic symbol and a buffer position. This buffer position is call the relative indent point for the line. Some syntactic symbols may not have a relative indent point associated with them. After the syntactic context list for a line is generated, cc-mode calculates the absolute indentation for the line by looking at each syntactic element in the list. First, it compares the syntactic element against the SYNTACTIC-SYMBOL's in `c-offsets-alist'. When it finds a match, it adds the OFFSET to the column of the relative indent point. The sum of this calculation for each element in the syntactic list is the absolute offset for line being indented. If the syntactic element does not match any in the `c-offsets-alist', an error is generated if `c-strict-syntax-p' is non-nil, otherwise the element is ignored. Actually, OFFSET can be an integer, a function, a variable, or one of the following symbols: `+', `-', `++', `--', `*', or `/'. These latter designate positive or negative multiples of `c-basic-offset', respectively: *1, *-1, *2, *-2, *0.5, and *-0.5. If OFFSET is a function, it is called with a single argument containing the cons of the syntactic element symbol and the relative indent point. The function should return an integer offset. Here is the current list of valid syntactic element symbols: string -- inside multi-line string c -- inside a multi-line C style block comment defun-open -- brace that opens a function definition defun-close -- brace that closes a function definition defun-block-intro -- the first line in a top-level defun class-open -- brace that opens a class definition class-close -- brace that closes a class definition inline-open -- brace that opens an in-class inline method inline-close -- brace that closes an in-class inline method ansi-funcdecl-cont -- the nether region between an ANSI function declaration and the defun opening brace knr-argdecl-intro -- first line of a K&R C argument declaration knr-argdecl -- subsequent lines in a K&R C argument declaration topmost-intro -- the first line in a topmost construct definition topmost-intro-cont -- topmost definition continuation lines member-init-intro -- first line in a member initialization list member-init-cont -- subsequent member initialization list lines inher-intro -- first line of a multiple inheritance list inher-cont -- subsequent multiple inheritance lines block-open -- statement block open brace block-close -- statement block close brace brace-list-open -- open brace of an enum or static array list brace-list-close -- close brace of an enum or static array list brace-list-intro -- first line in an enum or static array list brace-list-entry -- subsequent lines in an enum or static array list statement -- a C/C++/ObjC statement statement-cont -- a continuation of a C/C++/ObjC statement statement-block-intro -- the first line in a new statement block statement-case-intro -- the first line in a case `block' statement-case-open -- the first line in a case block starting with brace substatement -- the first line after an if/while/for/do/else substatement-open -- the brace that opens a substatement block case-label -- a case or default label access-label -- C++ private/protected/public access label label -- any non-special C/C++/ObjC label do-while-closure -- the `while' that ends a do/while construct else-clause -- the `else' of an if/else construct comment-intro -- a line containing only a comment introduction arglist-intro -- the first line in an argument list arglist-cont -- subsequent argument list lines when no arguments follow on the same line as the the arglist opening paren arglist-cont-nonempty -- subsequent argument list lines when at least one argument follows on the same line as the arglist opening paren arglist-close -- the solo close paren of an argument list stream-op -- lines continuing a stream operator construct inclass -- the construct is nested inside a class definition cpp-macro -- the start of a cpp macro friend -- a C++ friend declaration objc-method-intro -- the first line of an Objective-C method definition objc-method-args-cont -- lines continuing an Objective-C method definition objc-method-call-cont -- lines continuing an Objective-C method call Vc-tab-always-indent *Controls the operation of the TAB key. If t, hitting TAB always just indents the current line. If nil, hitting TAB indents the current line if point is at the left margin or in the line's indentation, otherwise it insert a real tab character. If other than nil or t, then tab is inserted only within literals -- defined as comments and strings -- and inside preprocessor directives, but line is always reindented. Note that indentation of lines containing only comments is also controlled by the `c-comment-only-line-offset' variable. Vc-comment-only-line-offset *Extra offset for line which contains only the start of a comment. Can contain an integer or a cons cell of the form: (NON-ANCHORED-OFFSET . ANCHORED-OFFSET) Where NON-ANCHORED-OFFSET is the amount of offset given to non-column-zero anchored comment-only lines, and ANCHORED-OFFSET is the amount of offset to give column-zero anchored comment-only lines. Just an integer as value is equivalent to (<val> . -1000). Vc-indent-comments-syntactically-p *Specifies how comment-only lines should be indented. When this variable is non-nil, comment-only lines are indented according to syntactic analysis via `c-offsets-alist', even when \[indent-for-comment] is used. Vc-block-comments-indent-p *Specifies how to re-indent C style block comments. Examples of the supported styles of C block comment indentation are shown below. When this variable is nil, block comments are indented as shown in styles 1 through 4. If this variable is non-nil, block comments are indented as shown in style 5. Note that cc-mode does not automatically insert any stars or block comment delimiters. You must type these in manually. This variable only controls how the lines within the block comment are indented when you hit ``\[c-indent-command]''. style 1: style 2 (GNU): style 3: style 4: style 5: /* /* Blah /* /* /* blah blah. */ * blah ** blah blah blah * blah ** blah blah */ */ */ */ Vc-cleanup-list *List of various C/C++/ObjC constructs to "clean up". These clean ups only take place when the auto-newline feature is turned on, as evidenced by the `/a' or `/ah' appearing next to the mode name. Valid symbols are: brace-else-brace -- cleans up `} else {' constructs by placing entire construct on a single line. This clean up only takes place when there is nothing but white space between the braces and the `else'. Clean up occurs when the open-brace after the `else' is typed. empty-defun-braces -- cleans up empty defun braces by placing the braces on the same line. Clean up occurs when the defun closing brace is typed. defun-close-semi -- cleans up the terminating semi-colon on defuns by placing the semi-colon on the same line as the closing brace. Clean up occurs when the semi-colon is typed. list-close-comma -- cleans up commas following braces in array and aggregate initializers. Clean up occurs when the comma is typed. scope-operator -- cleans up double colons which may designate a C++ scope operator split across multiple lines. Note that certain C++ constructs can generate ambiguous situations. This clean up only takes place when there is nothing but whitespace between colons. Clean up occurs when the second colon is typed. Vc-hanging-braces-alist *Controls the insertion of newlines before and after braces. This variable contains an association list with elements of the following form: (SYNTACTIC-SYMBOL . ACTION). When a brace (either opening or closing) is inserted, the syntactic context it defines is looked up in this list, and if found, the associated ACTION is used to determine where newlines are inserted. If the context is not found, the default is to insert a newline both before and after the brace. SYNTACTIC-SYMBOL can be any of: defun-open, defun-close, class-open, class-close, inline-open, inline-close, block-open, block-close, substatement-open, statement-case-open, brace-list-open, brace-list-close, brace-list-intro, or brace-list-entry. See `c-offsets-alist' for details. ACTION can be either a function symbol or a list containing any combination of the symbols `before' or `after'. If the list is empty, no newlines are inserted either before or after the brace. When ACTION is a function symbol, the function is called with a two arguments: the syntactic symbol for the brace and the buffer position at which the brace was inserted. The function must return a list as described in the preceding paragraph. Note that during the call to the function, the variable `c-syntactic-context' is set to the entire syntactic context for the brace line. Vc-hanging-colons-alist *Controls the insertion of newlines before and after certain colons. This variable contains an association list with elements of the following form: (SYNTACTIC-SYMBOL . ACTION). See the variable `c-hanging-braces-alist' for the semantics of this variable. Note however that making ACTION a function symbol is currently not supported for this variable. Vc-hanging-semi&comma-criteria *List of functions that decide whether to insert a newline or not. The functions in this list are called, in order, whenever the auto-newline minor mode is activated (as evidenced by a `/a' or `/ah' string in the mode line), and a semicolon or comma is typed (see `c-electric-semi&comma'). Each function in this list is called with no arguments, and should return one of the following values: nil -- no determination made, continue checking 'stop -- do not insert a newline, and stop checking (anything else) -- insert a newline, and stop checking If every function in the list is called with no determination made, then no newline is inserted. Vc-hanging-comment-ender-p *If nil, `c-fill-paragraph' leaves C block comment enders on their own line. Default value is t, which inhibits leaving block comment ending string `*/' on a line by itself. This is BOCM's sole behavior. Vc-backslash-column *Column to insert backslashes when macroizing a region. Vc-special-indent-hook *Hook for user defined special indentation adjustments. This hook gets called after a line is indented by the mode. Vc-delete-function *Function called by `c-electric-delete' when deleting characters. Vc-electric-pound-behavior *List of behaviors for electric pound insertion. Only currently supported behavior is `alignleft'. Vc-recognize-knr-p *If non-nil, `c-mode' and `objc-mode' will recognize K&R constructs. This variable is needed because of ambiguities in C syntax that make fast recognition of K&R constructs problematic, and slow. If you are coding with ANSI prototypes, set this variable to nil to speed up recognition of certain constructs. By setting this variable to nil, I have seen an increase of 20 times under some circumstance. Vc-progress-interval *Interval used to update progress status during long re-indentation. If a number, percentage complete gets updated after each interval of that many seconds. Set to nil to inhibit updating. This is only useful for Emacs 19. Vc-style-alist Styles of Indentation. Elements of this alist are of the form: (STYLE-STRING (VARIABLE . VALUE) [(VARIABLE . VALUE) ...]) where STYLE-STRING is a short descriptive string used to select a style, VARIABLE is any cc-mode variable, and VALUE is the intended value for that variable when using the selected style. There is one special case when VARIABLE is `c-offsets-alist'. In this case, the VALUE is a list containing elements of the form: (SYNTACTIC-SYMBOL . VALUE) as described in `c-offsets-alist'. These are passed directly to `c-set-offset' so there is no need to set every syntactic symbol in your style, only those that are different from the default. Note that all styles inherit from the "CC-MODE" style, which is computed at the time the mode is loaded. Vc-file-style *Variable interface for setting style via File Local Variables. In a file's Local Variable section, you can set this variable to a string suitable for `c-set-style'. When the file is visited, cc-mode will set the style of the file to this value automatically. Note that file style settings are applied before file offset settings as designated in the variable `c-file-offsets'. Vc-file-offsets *Variable interface for setting offsets via File Local Variables. In a file's Local Variable section, you can set this variable to an association list similiar to the values allowed in `c-offsets-alist'. When the file is visited, cc-mode will institute these offset settings automatically. Note that file offset settings are applied after file style settings as designated in the variable `c-file-style'. Vc-mode-hook *Hook called by `c-mode'. Vc++-mode-hook *Hook called by `c++-mode'. Vobjc-mode-hook *Hook called by `objc-mode'. Vc-mode-common-hook *Hook called by `c-mode', `c++-mode', and 'objc-mode' during common init. Vc-mode-menu XEmacs 19 (formerly Lucid) menu for C/C++/ObjC modes. Vc-emacs-features A list of features extant in the Emacs you are using. There are many flavors of Emacs out there, each with different features supporting those needed by cc-mode. Here's the current supported list, along with the values for this variable: Vanilla Emacs 18/Epoch 4: (v18 no-dual-comments) Emacs 18/Epoch 4 (patch2): (v18 8-bit) XEmacs (formerly Lucid) 19: (v19 8-bit) FSF Emacs 19: (v19 1-bit). Vc++-mode-abbrev-table Abbrev table in use in c++-mode buffers. Vc-mode-abbrev-table Abbrev table in use in c-mode buffers. Vobjc-mode-abbrev-table Abbrev table in use in objc-mode buffers. Vc-mode-map Keymap used in c-mode buffers. Vc++-mode-map Keymap used in c++-mode buffers. Vobjc-mode-map Keymap used in objc-mode buffers. Vc-mode-syntax-table Syntax table used in c-mode buffers. Vc++-mode-syntax-table Syntax table used in c++-mode buffers. Vobjc-mode-syntax-table Syntax table used in objc-mode buffers. Vc-hungry-delete-key Internal state of hungry delete key feature. Vc-auto-newline Internal state of auto newline feature. Vc-auto-hungry-string Internal auto-newline/hungry-delete designation string for mode line. Vc-syntactic-context Variable containing syntactic analysis list during indentation. Vc-comment-start-regexp Buffer local variable describing how comment are introduced. Vc-conditional-key Buffer local language-specific conditional keyword regexp. Vc-access-key Buffer local language-specific access key regexp. Vc-class-key Buffer local language-specific class key regexp. Vc-protection-key Regexp describing protection keywords. Vc-symbol-key Regexp describing a C/C++/ObjC symbol. We cannot use just `word' syntax class since `_' cannot be in word class. Putting underscore in word class breaks forward word movement behavior that users are familiar with. Vc-baseclass-key Regexp describing C++ base classes in a derived class definition. Vc-C++-class-key Regexp describing a C++ class declaration, including templates. Vc-C-class-key Regexp describing a C struct declaration. Vc-inher-key Regexp describing a class inheritance declaration. Vc-switch-label-key Regexp describing a switch's case or default label Vc-C++-access-key Regexp describing C++ access specification keywords. Vc-label-key Regexp describing any label. Vc-C-conditional-key Regexp describing a conditional control. Vc-C++-conditional-key Regexp describing a conditional control for C++. Vc-C++-friend-key Regexp describing friend declarations in C++ classes. Vc-C++-comment-start-regexp Dual comment value for `c-comment-start-regexp'. Vc-C-comment-start-regexp Single comment style value for `c-comment-start-regexp'. Vc-ObjC-method-key Regexp describing an Objective-C method intro. Vc-ObjC-access-key Regexp describing access specification keywords for Objective-C. Vc-ObjC-class-key Regexp describing a class or protocol declaration for Objective-C. Fc++-mode Major mode for editing C++ code. To submit a problem report, enter `\[c-submit-bug-report]' from a c++-mode buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducable test case and send the message. To see what version of cc-mode you are running, enter `\[c-version]'. Note that the details of configuring c++-mode have been moved to the accompanying texinfo manual (which is not yet completed -- volunteers are welcome). Until then, please read the README file that came with the cc-mode distribution. The hook variable `c++-mode-hook' is run with no args, if that variable is bound and has a non-nil value. Also the common hook c-mode-common-hook is run first, by this defun, `c-mode', and `objc-mode'. Key bindings: \{c++-mode-map} Fc-mode Major mode for editing K&R and ANSI C code. To submit a problem report, enter `\[c-submit-bug-report]' from a c-mode buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducable test case and send the message. To see what version of cc-mode you are running, enter `\[c-version]'. Note that the details of configuring c-mode have been moved to the accompanying texinfo manual (which is not yet completed -- volunteers are welcome). Until then, please read the README file that came with the cc-mode distribution. The hook variable `c-mode-hook' is run with no args, if that value is bound and has a non-nil value. Also the common hook c-mode-common-hook is run first, by this defun, `c++-mode', and `objc-mode'. Key bindings: \{c-mode-map} Fobjc-mode Major mode for editing Objective C code. To submit a problem report, enter `\[c-submit-bug-report]' from an objc-mode buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducable test case and send the message. To see what version of cc-mode you are running, enter `\[c-version]'. Note that the details of configuring objc-mode have been moved to the accompanying texinfo manual (which is not yet completed -- volunteers are welcome). Until then, please read the README file that came with the cc-mode distribution. The hook variable `objc-mode-hook' is run with no args, if that value is bound and has a non-nil value. Also the common hook c-mode-common-hook is run first, by this defun, `c-mode', and `c++-mode'. Key bindings: \{objc-mode-map} Fc-postprocess-file-styles Function that post processes relevent file local variables. Currently, this function simply applies any style and offset settings found in the file's Local Variable list. It first applies any style setting found in `c-file-style', then it applies any offset settings it finds in `c-file-offsets'. Fc-enable-//-in-c-mode Enables // as a comment delimiter in `c-mode'. ANSI C currently does *not* allow this, although many C compilers support optional C++ style comments. To use, call this function from your `.emacs' file before you visit any C files. The changes are global and affect all future `c-mode' buffers. Fc-toggle-auto-state Toggle auto-newline feature. Optional numeric ARG, if supplied turns on auto-newline when positive, turns it off when negative, and just toggles it when zero. When the auto-newline feature is enabled (as evidenced by the `/a' or `/ah' on the modeline after the mode name) newlines are automatically inserted after special characters such as brace, comma, semi-colon, and colon. Fc-toggle-hungry-state Toggle hungry-delete-key feature. Optional numeric ARG, if supplied turns on hungry-delete when positive, turns it off when negative, and just toggles it when zero. When the hungry-delete-key feature is enabled (as evidenced by the `/h' or `/ah' on the modeline after the mode name) the delete key gobbles all preceding whitespace in one fell swoop. Fc-toggle-auto-hungry-state Toggle auto-newline and hungry-delete-key features. Optional numeric ARG, if supplied turns on auto-newline and hungry-delete when positive, turns them off when negative, and just toggles them when zero. See `c-toggle-auto-state' and `c-toggle-hungry-state' for details. Fc-electric-delete Deletes preceding character or whitespace. If `c-hungry-delete-key' is non-nil, as evidenced by the "/h" or "/ah" string on the mode line, then all preceding whitespace is consumed. If however an ARG is supplied, or `c-hungry-delete-key' is nil, or point is inside a literal then the function in the variable `c-delete-function' is called. Fc-electric-pound Electric pound (`#') insertion. Inserts a `#' character specially depending on the variable `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is inside a literal, nothing special happens. Fc-electric-brace Insert a brace. If the auto-newline feature is turned on, as evidenced by the "/a" or "/ah" string on the mode line, newlines are inserted before and after braces based on the value of `c-hanging-braces-alist'. Also, the line is re-indented unless a numeric ARG is supplied, there are non-whitespace characters present on the line after the brace, or the brace is inserted inside a literal. Fc-electric-slash Insert a slash character. If slash is second of a double-slash C++ style comment introducing construct, and we are on a comment-only-line, indent line as comment. If numeric ARG is supplied or point is inside a literal, indentation is inhibited. Fc-electric-star Insert a star character. If the star is the second character of a C style comment introducing construct, and we are on a comment-only-line, indent line as comment. If numeric ARG is supplied or point is inside a literal, indentation is inhibited. Fc-electric-semi&comma Insert a comma or semicolon. When the auto-newline feature is turned on, as evidenced by the "/a" or "/ah" string on the mode line, a newline might be inserted. See the variable `c-hanging-semi&comma-criteria' for how newline insertion is determined. When semicolon is inserted, the line is re-indented unless a numeric arg is supplied, point is inside a literal, or there are non-whitespace characters on the line following the semicolon. Fc-semi&comma-inside-parenlist Determine if a newline should be added after a semicolon. If a comma was inserted, no determination is made. If a semicolon was inserted inside a parenthesis list, no newline is added otherwise a newline is added. In either case, checking is stopped. This supports exactly the old newline insertion behavior. Fc-electric-colon Insert a colon. If the auto-newline feature is turned on, as evidenced by the "/a" or "/ah" string on the mode line, newlines are inserted before and after colons based on the value of `c-hanging-colons-alist'. Also, the line is re-indented unless a numeric ARG is supplied, there are non-whitespace characters present on the line after the colon, or the colon is inserted inside a literal. This function cleans up double colon scope operators based on the value of `c-cleanup-list'. Fc-set-offset Change the value of a syntactic element symbol in `c-offsets-alist'. SYMBOL is the syntactic element symbol to change and OFFSET is the new offset for that syntactic element. Optional ADD says to add SYMBOL to `c-offsets-alist' if it doesn't already appear there. Fc-set-style Set cc-mode variables to use one of several different indentation styles. STYLENAME is a string representing the desired style from the list of styles described in the variable `c-style-alist'. See that variable for details of setting up styles. Fc-add-style Adds a style to `c-style-alist', or updates an existing one. STYLE is a string identifying the style to add or update. DESCRIP is an association list describing the style and must be of the form: ((VARIABLE . VALUE) [(VARIABLE . VALUE) ...]) See the variable `c-style-alist' for the semantics of VARIABLE and VALUE. This function also sets the current style to STYLE using `c-set-style' if the optional SET-P flag is non-nil. Fc-fill-paragraph Like \[fill-paragraph] but handles C and C++ style comments. If any of the current line is a comment or within a comment, fill the comment or the paragraph of it that point is in, preserving the comment indentation or line-starting decorations. Fc-forward-into-nomenclature Move forward to end of a nomenclature section or word. With arg, to it arg times. Fc-backward-into-nomenclature Move backward to beginning of a nomenclature section or word. With optional ARG, move that many times. If ARG is negative, move forward. Fc-scope-operator Insert a double colon scope operator at point. No indentation or other "electric" behavior is performed. Fc-beginning-of-statement Go to the beginning of the innermost C statement. With prefix arg, go back N - 1 statements. If already at the beginning of a statement then go to the beginning of the preceding one. If within a string or comment, or next to a comment (only whitespace between), move by sentences instead of statements. When called from a program, this function takes 2 optional args: the prefix arg, and a buffer position limit which is the farthest back to search. Fc-end-of-statement Go to the end of the innermost C statement. With prefix arg, go forward N - 1 statements. Move forward to end of the next statement if already at end. If within a string or comment, move by sentences instead of statements. When called from a program, this function takes 2 optional args: the prefix arg, and a buffer position limit which is the farthest back to search. Fc-up-conditional Move back to the containing preprocessor conditional, leaving mark behind. A prefix argument acts as a repeat count. With a negative argument, move forward to the end of the containing preprocessor conditional. When going backwards, `#elif' is treated like `#else' followed by `#if'. When going forwards, `#elif' is ignored. Fc-backward-conditional Move back across a preprocessor conditional, leaving mark behind. A prefix argument acts as a repeat count. With a negative argument, move forward across a preprocessor conditional. Fc-forward-conditional Move forward across a preprocessor conditional, leaving mark behind. A prefix argument acts as a repeat count. With a negative argument, move backward across a preprocessor conditional. Fc-indent-command Indent current line as C++ code, or in some cases insert a tab character. If `c-tab-always-indent' is t, always just indent the current line. If nil, indent the current line only if point is at the left margin or in the line's indentation; otherwise insert a tab. If other than nil or t, then tab is inserted only within literals (comments and strings) and inside preprocessor directives, but line is always reindented. A numeric argument, regardless of its value, means indent rigidly all the lines of the expression starting after point so that this line becomes properly indented. The relative indentation among the lines of the expression are preserved. Fc-indent-exp Indent each line in balanced expression following point. Optional SHUTUP-P if non-nil, inhibits message printing and error checking. Fc-indent-defun Re-indents the current top-level function def, struct or class declaration. Fc-mark-function Put mark at end of a C, C++, or Objective-C defun, point at beginning. Fc-show-syntactic-information Show syntactic information for current line. Fc-snug-do-while Dynamically calculate brace hanginess for do-while statements. Using this function, `while' clauses that end a `do-while' block will remain on the same line as the brace that closes that block. See `c-hanging-braces-alist' for how to utilize this function as an ACTION associated with `block-close' syntax. Fc-backslash-region Insert, align, or delete end-of-line backslashes on the lines in the region. With no argument, inserts backslashes and aligns existing backslashes. With an argument, deletes the backslashes. This function does not modify the last line of the region if the region ends right at the start of the following line; it does not modify blank lines at the start of the region. So you can put the region around an entire macro definition and conveniently use this command. Vc-version cc-mode version number. Vc-mode-help-address Address accepting submission of bug reports. Fc-version Echo the current version of cc-mode in the minibuffer. Fc-submit-bug-report Submit via mail a bug report on cc-mode. Fc-popup-menu Pops up the C/C++/ObjC menu. Vvc-master-templates *Where to look for version-control master files. The first pair corresponding to a given back end is used as a template when creating new masters. Vvc-make-backup-files *If non-nil, backups of registered files are made as with other files. If nil (the default), files covered by version control don't get backups. Vvc-display-status *If non-nil, display revision number and lock status in modeline. Otherwise, not displayed. Vvc-file-prop-obarray Obarray for per-file properties. Fvc-name Return the master name of a file, nil if it is not registered. Fvc-backend-deduce Return the version-control type of a file, nil if it is not registered. Fvc-toggle-read-only Change read-only status of current buffer, perhaps via version control. If the buffer is visiting a file registered with a form of version control that locks files by making them read-only (i.e.: not CVS), then check the file in or out. Otherwise, just change the read-only flag of the buffer. If you provide a prefix argument, we pass it on to `vc-next-action'. Fvc-mode-line Set `vc-mode' to display type of version control for FILE. The value is set in the current buffer, which should be the buffer visiting FILE. Second optional arg LABEL is put in place of version control system name. Fvc-file-not-found-hook When file is not found, try to check it out from RCS or SCCS. Returns t if checkout was successful, nil otherwise. Vvc-menu Menubar entry for using the revision control system. Vcase-replace *Non-nil means `query-replace' should preserve case in replacements. What this means is that `query-replace' will change the case of the replacement text so that it matches the text that was replaced. If this variable is nil, the replacement text will be inserted exactly as it was specified by the user, irrespective of the case of the text that was replaced. Note that this flag has no effect if `case-fold-search' is nil, or if the replacement text has any uppercase letters in it. Fquery-replace Replace some occurrences of FROM-STRING with TO-STRING. As each match is found, the user must type a character saying what to do with it. For directions, type \[help-command] at that time. Preserves case in each replacement if `case-replace' and `case-fold-search' are non-nil and FROM-STRING has no uppercase letters. Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace only matches surrounded by word boundaries. To customize possible responses, change the "bindings" in `query-replace-map'. Fquery-replace-regexp Replace some things after point matching REGEXP with TO-STRING. As each match is found, the user must type a character saying what to do with it. For directions, type \[help-command] at that time. Preserves case in each replacement if `case-replace' and `case-fold-search' are non-nil and REGEXP has no uppercase letters. Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace only matches surrounded by word boundaries. In TO-STRING, `\&' stands for whatever matched the whole of REGEXP, and `\=\N' (where N is a digit) stands for whatever what matched the Nth `$...$' in REGEXP. Fmap-query-replace-regexp Replace some matches for REGEXP with various strings, in rotation. The second argument TO-STRINGS contains the replacement strings, separated by spaces. This command works like `query-replace-regexp' except that each successive replacement uses the next successive replacement string, wrapping around from the last such string to the first. Non-interactively, TO-STRINGS may be a list of replacement strings. A prefix argument N says to use each replacement string N times before rotating to the next. Freplace-string Replace occurrences of FROM-STRING with TO-STRING. Preserve case in each match if `case-replace' and `case-fold-search' are non-nil and FROM-STRING has no uppercase letters. Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace only matches surrounded by word boundaries. This function is usually the wrong thing to use in a Lisp program. What you probably want is a loop like this: (while (search-forward FROM-STRING nil t) (replace-match TO-STRING nil t)) which will run faster and will not set the mark or print anything. Freplace-regexp Replace things after point matching REGEXP with TO-STRING. Preserve case in each match if `case-replace' and `case-fold-search' are non-nil and REGEXP has no uppercase letters. Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace only matches surrounded by word boundaries. In TO-STRING, `\&' stands for whatever matched the whole of REGEXP, and `\=\N' (where N is a digit) stands for whatever what matched the Nth `$...$' in REGEXP. This function is usually the wrong thing to use in a Lisp program. What you probably want is a loop like this: (while (re-search-forward REGEXP nil t) (replace-match TO-STRING nil nil)) which will run faster and will not set the mark or print anything. Vregexp-history History list for some commands that read regular expressions. Fdelete-non-matching-lines Delete all lines except those containing matches for REGEXP. A match split across lines preserves all the lines it lies in. Applies to all lines after point. Fdelete-matching-lines Delete lines containing matches for REGEXP. If a match is split across lines, all the lines it lies in are deleted. Applies to lines after point. Fcount-matches Print number of matches for REGEXP following point. Foccur-mode Major mode for output from \[occur]. Move point to one of the occurrences in this buffer, then use \[occur-mode-goto-occurrence] to go to the same occurrence Or click \<occur-mode-map>\[occur-mode-mouse-goto] on an occurrence line. in the buffer that the occurrences were found in. \{occur-mode-map} Foccur-mode-mouse-goto go to occurence highlighted by mouse. This function is only reasonable when bound to a mouse key in the occur buffer Foccur-mode-goto-occurrence Go to the occurrence the current line describes. Vlist-matching-lines-default-context-lines *Default number of context lines to include around a `list-matching-lines' match. A negative number means to include that many lines before the match. A positive number means to include that many lines both before and after. Vlist-matching-lines-whole-buffer If t, occur operates on whole buffer, otherwise occur starts from point. default is nil. Flist-matching-lines Show all lines in the current buffer containing a match for REGEXP. If a match spreads across multiple lines, all those lines are shown. If variable `list-matching-lines-whole-buffer' is non-nil, the entire buffer is searched, otherwise search begins at point. Each line is displayed with NLINES lines before and after, or -NLINES before if NLINES is negative. NLINES defaults to `list-matching-lines-default-context-lines'. Interactively it is the prefix arg. The lines are shown in a buffer named `*Occur*'. It serves as a menu to find any of the occurrences in this buffer. \[describe-mode] in that buffer will explain how. Vquery-replace-help Help message while in query-replace Vquery-replace-map Keymap that defines the responses to questions in `query-replace'. The "bindings" in this map are not commands; they are answers. The valid answers include `act', `skip', `act-and-show', `exit', `act-and-exit', `edit', `delete-and-edit', `recenter', `automatic', `backup', and `help'. Fperform-replace Subroutine of `query-replace'. Its complexity handles interactive queries. Don't use this in your own program unless you want to query and set the mark just as `query-replace' does. Instead, write a simple loop like this: (while (re-search-forward "foo[ ]+bar" nil t) (replace-match "foobar" nil nil)) which will run faster and probably do exactly what you want. Fmatch-string Returns the Nth subexpression matched by the last regular expression search. The second argument, STRING, must be specified if the last regular expression search was done with `string-match'. Fsave-match-data Execute FORMS, restoring the global value of the match data. Fmake-specifier-and-init Create and initialize a new specifier. This is a front-end onto `make-specifier' that allows you to create a specifier and add specs to it at the same time. TYPE specifies the specifier type. SPEC-LIST supplies the specification(s) to be added to the specifier. Normally, almost any reasonable abbreviation of the full spec-list form is accepted, and is converted to the full form; however, if optional argument DONT-CANONICALIZE is non-nil, this conversion is not performed, and the SPEC-LIST must already be in full form. See `canonicalize-spec-list'. Fmap-specifier Apply MS-FUNC to the specification(s) for MS-LOCALE in MS-SPECIFIER. If MS-LOCALE is a locale, MS-FUNC will be called for that locale. If MS-LOCALE is a locale type, MS-FUNC will be mapped over all locales of that type. If MS-LOCALE is 'all or nil, MS-FUNC will be mapped over all locales in MS-SPECIFIER. MS-FUNC is called with four arguments: the MS-SPECIFIER, the locale being mapped over, the inst-list for that locale, and the optional MS-MAPARG. If any invocation of MS-FUNC returns non-nil, the mapping will stop and the returned value becomes the value returned from `map-specifier'. Otherwise, `map-specifier' returns nil. Fcanonicalize-inst-pair Canonicalize the given INST-PAIR. SPECIFIER-TYPE specifies the type of specifier that this SPEC-LIST will be used for. Canonicalizing means converting to the full form for an inst-pair, i.e. `(TAG-SET . INSTANTIATOR)'. A single, untagged instantiator is given a tag set of nil (the empty set), and a single tag is converted into a tag set consisting only of that tag. If NOERROR is non-nil, signal an error if the inst-pair is invalid; otherwise return t. Fcanonicalize-inst-list Canonicalize the given INST-LIST (a list of inst-pairs). SPECIFIER-TYPE specifies the type of specifier that this INST-LIST will be used for. Canonicalizing means converting to the full form for an inst-list, i.e. `((TAG-SET . INSTANTIATOR) ...)'. This function accepts a single inst-pair or any abbrevation thereof or a list of (possibly abbreviated) inst-pairs. (See `canonicalize-inst-pair'.) If NOERROR is non-nil, signal an error if the inst-list is invalid; otherwise return t. Fcanonicalize-spec Canonicalize the given SPEC (a specification). SPECIFIER-TYPE specifies the type of specifier that this SPEC-LIST will be used for. Canonicalizing means converting to the full form for a spec, i.e. `(LOCALE (TAG-SET . INSTANTIATOR) ...)'. This function accepts a possibly abbreviated inst-list or a cons of a locale and a possibly abbreviated inst-list. (See `canonicalize-inst-list'.) If NOERROR is nil, signal an error if the specification is invalid; otherwise return t. Fcanonicalize-spec-list Canonicalize the given SPEC-LIST (a list of specifications). SPECIFIER-TYPE specifies the type of specifier that this SPEC-LIST will be used for. Canonicalizing means converting to the full form for a spec-list, i.e. `((LOCALE (TAG-SET . INSTANTIATOR) ...) ...)'. This function accepts a possibly abbreviated specification or a list of such things. (See `canonicalize-spec'.) This is the function used to convert spec-lists accepted by `set-specifier' and such into a form suitable for `add-spec-list-to-specifier'. This function tries extremely hard to resolve any ambiguities, and the built-in specifier types (font, image, toolbar, etc.) are designed so that there won't be any ambiguities. If NOERROR is nil, signal an error if the spec-list is invalid; otherwise return t. Fset-specifier Add some specifications to SPECIFIER. VALUE can be a single instantiator or tagged instantiator (added as a global specification), a list of tagged and/or untagged instantiators (added as a global specification), a cons of a locale and instantiator or locale and instantiator list, a list of such conses, or nearly any other reasonable form. More specifically, VALUE can be anything accepted by `canonicalize-spec-list'. HOW-TO-ADD is the same as in `add-spec-to-specifier'. Note that `set-specifier' is exactly complementary to `specifier-specs' except in the case where SPECIFIER has no specs at all in it but nil is a valid instantiator (in that case, `specifier-specs' will return nil (meaning no specs) and `set-specifier' will interpret the `nil' as meaning "I'm adding a global instantiator and its value is `nil'"), or in strange cases where there is an ambiguity between a spec-list and an inst-list, etc. (The built-in specifier types are designed in such a way as to avoid any such ambiguities.) If you want to work with spec-lists, you should probably not use these functions, but should use the lower-level functions `specifier-spec-list' and `add-spec-list-to-specifier'. These functions always work with fully-qualified spec-lists; thus, there is no possibility for ambiguity and no need to go through the function `canonicalize-spec-list', which is potentially time-consuming. VBuffer-menu-mode-map FBuffer-menu-mode Major mode for editing a list of buffers. Each line describes one of the buffers in Emacs. Letters do not insert themselves; instead, they are commands. m -- mark buffer to be displayed. q -- select buffer of line point is on. Also show buffers marked with m in other windows. 1 -- select that buffer in full-frame window. 2 -- select that buffer in one window, together with buffer selected before this one in another window. f -- select that buffer in place of the buffer menu buffer. o -- select that buffer in another window, so the buffer menu buffer remains visible in its window. t -- visit-tags-table this buffer. ~ -- clear modified-flag on that buffer. s -- mark that buffer to be saved, and move down. d or k -- mark that buffer to be deleted, and move down. C-d -- mark that buffer to be deleted, and move up. x -- delete or save marked buffers. u -- remove all kinds of marks from current line. Delete -- back up a line and remove marks. Precisely,\{Buffer-menu-mode-map} FBuffer-menu-buffer Return buffer described by this line of buffer menu. Vlist-buffers-identification String used to identify this buffer, or a function of one argument to generate such a string. This variable is always buffer-local. Flist-buffers Display a list of names of existing buffers. Inserts it in buffer *Buffer List* and displays that. Note that buffers with names starting with spaces are omitted. Non-null optional arg FILES-ONLY means mention only file buffers. The M column contains a * for buffers that are modified. The R column contains a % for buffers that are read-only. Fbuffer-menu Make a menu of buffers so you can save, delete or select them. With argument, show only buffers that are visiting files. Type ? after invocation to get help on commands available. Type q immediately to make the buffer menu go away. FBuffer-menu-mark Mark buffer on this line for being displayed by \[Buffer-menu-select] command. FBuffer-menu-unmark Cancel all requested operations on buffer on this line. FBuffer-menu-backup-unmark Move up and cancel all requested operations on buffer on line above. FBuffer-menu-delete Mark buffer on this line to be deleted by \[Buffer-menu-execute] command. FBuffer-menu-delete-backwards Mark buffer on this line to be deleted by \[Buffer-menu-execute] command and then move up one line FBuffer-menu-save Mark buffer on this line to be saved by \[Buffer-menu-execute] command. FBuffer-menu-not-modified Mark buffer on this line as unmodified (no changes to save). FBuffer-menu-execute Save and/or delete buffers marked with \[Buffer-menu-save] or \[Buffer-menu-delete] commands. FBuffer-menu-select Select this line's buffer; also display buffers marked with ">". You can mark buffers with the \[Buffer-menu-mark] command. FBuffer-menu-visit-tags-table Visit the tags table in the buffer on this line. See `visit-tags-table'. FBuffer-menu-1-window Select this line's buffer, alone, in full frame. FBuffer-menu-this-window Select this line's buffer in this window. FBuffer-menu-other-window Select this line's buffer in other window, leaving buffer menu visible. FBuffer-menu-2-window Select this line's buffer, with previous buffer in second window. Vmodeline-buffer-identification Modeline control for identifying the buffer being displayed. Its default value is "XEmacs: %17b". Major modes that edit things other than ordinary files may change this (e.g. Info, Dired,...) Vmodeline-process Modeline control for displaying info on process status. Normally nil in most modes, since there is no process to display. Vmodeline-modified Modeline control for displaying whether current buffer is modified. Vminor-mode-alist Alist saying how to show minor modes in the modeline. Each element looks like (VARIABLE STRING); STRING is included in the modeline iff VARIABLE's value is non-nil. Actually, STRING need not be a string; any possible modeline element is okay. See `modeline-format'. Fvm View Mail: an alternate mail reader for emacs. Optional first arg FOLDER specifies the folder to visit. It defaults to the value of vm-primary-inbox. The folder buffer is put into VM mode, a major mode for reading mail. Prefix arg or optional second arg READ-ONLY non-nil indicates that the folder should be considered read only. No attribute changes, messages additions or deletions will be allowed in the visited folder. Visiting the primary inbox causes any contents of the system mailbox to be moved and appended to the resulting buffer. All the messages can be read by repeatedly pressing SPC. Use `n'ext and `p'revious to move about in the folder. Messages are marked for deletion with `d', and saved to another folder with `s'. Quitting VM with `q' expunges deleted messages and saves the buffered folder to disk. See the documentation for vm-mode for more information. Fvm-mode View Mail: an alternate mail reader for emacs. Commands: h - summarize folder contents j - discard cached information about the current message n - go to next message p - go to previous message N - like `n' but ignores skip-variable settings P - like `p' but ignores skip-variable settings M-n - go to next unread message M-p - go to previous unread message RET - go to numbered message (uses prefix arg or prompts in minibuffer) TAB - go to last message seen M-s - incremental search through the folder t - display hidden headers SPC - scroll forward a page (if at end of message, then display next message) b - scroll backward a page < - go to beginning of current message > - go to end of current message d - delete message, prefix arg deletes messages forward (flag as deleted) C-d - delete message, prefix arg deletes messages backward (flag as deleted) u - undelete k - flag for deletion all messages with same subject as the current message r - reply (only to the sender of the message) R - reply with included text for current message M-r - extract and resend bounced message f - followup (reply to all recipients of message) F - followup with included text from the current message z - forward the current message m - send a message B - resend the current message to another user. c - continue composing the most recent message you were composing @ - digestify and mail entire folder contents (the folder is not modified) * - burst a digest into individual messages, and append and assimilate these message into the current folder. G - sort messages by various keys g - get any new mail that has arrived in the system mailbox (new mail is appended to the disk and buffer copies of the primary inbox.) v - visit another mail folder V - visit a virtual folder e - edit the current message s - save current message in a folder (appends if folder already exists) w - write current message to a file without its headers (appends if exists) S - save entire folder to disk, expunging deleted messages A - save unfiled messages to their vm-auto-folder-alist specified folders # - expunge deleted messages (without saving folder) q - quit VM, deleted messages are expunged, folder saved to disk x - exit VM with no change to the folder M N - use marks; the next vm command will affect only marked messages if it makes sense for the command to do so M M - mark the current message M U - unmark the current message M m - mark all messages M u - unmark all messages M ? - help for the mark commands W S - save the current window configuration to a name W D - delete a window configuration W W - apply a configuration W ? - help for the window configuration commands C-_ - undo, special undo that retracts the most recent changes in message attributes. Expunges and saves cannot be undone. C-x u is also bound to this command. L - reload your VM init file, ~/.vm ? - help ! - run a shell command | - run a shell command with the current message as input M-C - view conditions under which you may redistribute VM M-W - view the details of VM's lack of a warranty Variables: vm-auto-center-summary vm-auto-folder-alist vm-auto-folder-case-fold-search vm-auto-get-new-mail vm-auto-next-message vm-berkeley-mail-compatibility vm-check-folder-types vm-convert-folder-types vm-circular-folders vm-confirm-new-folders vm-confirm-quit vm-crash-box vm-delete-after-archiving vm-delete-after-bursting vm-delete-after-saving vm-delete-empty-folders vm-digest-burst-type vm-digest-center-preamble vm-digest-preamble-format vm-digest-send-type vm-folder-directory vm-folder-read-only vm-follow-summary-cursor vm-forwarded-headers vm-forwarding-digest-type vm-forwarding-subject-format vm-gargle-uucp vm-highlighted-header-regexp vm-honor-page-delimiters vm-in-reply-to-format vm-included-text-attribution-format vm-included-text-prefix vm-inhibit-startup-message vm-invisible-header-regexp vm-jump-to-new-messages vm-jump-to-unread-messages vm-keep-sent-messages vm-mail-header-from vm-mail-mode-hook vm-mail-window-percentage vm-mode-hook vm-move-after-deleting vm-move-after-undeleting vm-mutable-windows vm-preview-lines vm-preview-read-messages vm-primary-inbox vm-recognize-pop-maildrops vm-reply-ignored-addresses vm-reply-subject-prefix vm-resend-bounced-headers vm-resend-bounced-discard-header-regexp vm-resend-headers vm-resend-discard-header-regexp vm-retain-message-order vm-rfc1153-digest-discard-header-regexp vm-rfc1153-digest-headers vm-rfc934-digest-discard-header-regexp vm-rfc934-digest-headers vm-search-using-regexps vm-skip-deleted-messages vm-skip-read-messages vm-spool-files vm-startup-with-summary vm-strip-reply-headers vm-summary-format vm-unforwarded-header-regexp vm-virtual-folder-alist vm-virtual-mirror vm-visible-headers vm-visit-when-saving vm-window-configuration-file Fvm-visit-folder Visit a mail file with View Mail, an alternate mail reader for emacs. See the description of the `vm' and `vm-mode' functions. VM will parse and present its messages to you in the usual way. First arg FOLDER specifies the mail file to visit. When this command is called interactively the file name is read from the minibuffer. Prefix arg or optional second arg READ-ONLY non-nil indicates that the folder should be considered read only. No attribute changes, messages additions or deletions will be allowed in the visited folder. Fvm-mail Send a mail message from within View Mail, or from without. Feiffel-mode Major Mode for editing Eiffel programs. Fbyte-recompile-directory Recompile every `.el' file in DIRECTORY that needs recompilation. This is if a `.elc' file exists but is older than the `.el' file. If the `.elc' file does not exist, normally the `.el' file is *not* compiled. But a prefix argument (optional second arg) means ask user, for each such `.el' file, whether to compile it. Prefix argument 0 means don't ask and compile the file anyway. Fbyte-recompile-file Recompile a file of Lisp code named FILENAME if it needs recompilation. This is if the `.elc' file exists but is older than the `.el' file. If the `.elc' file does not exist, normally the `.el' file is *not* compiled. But a prefix argument (optional second arg) means ask user whether to compile it. Prefix argument 0 don't ask and recompile anyway. Fbyte-compile-file Compile a file of Lisp code named FILENAME into a file of byte code. The output file's name is made by appending `c' to the end of FILENAME. With prefix arg (noninteractively: 2nd arg), load the file after compiling. Fbyte-compile-and-load-file Compile a file of Lisp code named FILENAME into a file of byte code, and then load it. The output file's name is made by appending "c" to the end of FILENAME. Fbyte-compile-buffer Byte-compile and evaluate contents of BUFFER (default: the current buffer). Fcompile-defun Compile and evaluate the current top-level form. Print the result in the minibuffer. With argument, insert value in current buffer after the form. Fbyte-compile If FORM is a symbol, byte-compile its function definition. If FORM is a lambda or a macro, byte-compile it as a function. Fbyte-compile-sexp Compile and return SEXP. Fbatch-byte-compile Run `byte-compile-file' on the files remaining on the command line. Use this from the command line, with `-batch'; it won't work in an interactive Emacs. Each file is processed even if an error occurred previously. For example, invoke "emacs -batch -f batch-byte-compile $emacs/ ~/*.el" Fbatch-byte-recompile-directory-norecurse Same as `batch-byte-recompile-directory' but without recursion. Fbatch-byte-recompile-directory Runs `byte-recompile-directory' on the dirs remaining on the command line. Must be used only with -batch, and kills emacs on completion. For example, invoke "emacs -batch -f batch-byte-recompile-directory ." Fdisassemble Print disassembled code for OBJECT in (optional) BUFFER. OBJECT can be a symbol defined as a function, or a function itself (a lambda expression or a compiled-function object). If OBJECT is not already compiled, we compile it, but do not redefine OBJECT if it is a symbol. Vcalendar-setup The frame set up of the calendar. The choices are `one-frame' (calendar and diary together in one separate, dediciated frame) or `two-frames' (calendar and diary in separate, dedicated frames); with any other value the current frame is used. Vcalendar-week-start-day *The day of the week on which a week in the calendar begins. 0 means Sunday (default), 1 means Monday, and so on. Vcalendar-offset *The offset of the principal month from the center of the calendar window. 0 means the principal month is in the center (default), -1 means on the left, +1 means on the right. Larger (or smaller) values push the principal month off the screen. Vview-diary-entries-initially *Non-nil means display current date's diary entries on entry. The diary is displayed in another window when the calendar is first displayed, if the current date is visible. The number of days of diary entries displayed is governed by the variable `number-of-diary-entries'. Vnumber-of-diary-entries *Specifies how many days of diary entries are to be displayed initially. This variable affects the diary display when the command M-x diary is used, or if the value of the variable `view-diary-entries-initially' is t. For example, if the default value 1 is used, then only the current day's diary entries will be displayed. If the value 2 is used, then both the current day's and the next day's entries will be displayed. The value can also be a vector such as [0 2 2 2 2 4 1]; this value says to display no diary entries on Sunday, the display the entries for the current date and the day after on Monday through Thursday, display Friday through Monday's entries on Friday, and display only Saturday's entries on Saturday. This variable does not affect the diary display with the `d' command from the calendar; in that case, the prefix argument controls the number of days of diary entries displayed. Vmark-diary-entries-in-calendar *Non-nil means mark dates with diary entries, in the calendar window. The marking symbol is specified by the variable `diary-entry-marker'. Vview-calendar-holidays-initially *Non-nil means display holidays for current three month period on entry. The holidays are displayed in another window when the calendar is first displayed. Vmark-holidays-in-calendar *Non-nil means mark dates of holidays in the calendar window. The marking symbol is specified by the variable `calendar-holiday-marker'. Vall-hebrew-calendar-holidays *If nil, show only major holidays from the Hebrew calendar. This means only those Jewish holidays that appear on secular calendars. If t, show all the holidays that would appear in a complete Hebrew calendar. Vall-christian-calendar-holidays *If nil, show only major holidays from the Christian calendar. This means only those Christian holidays that appear on secular calendars. If t, show all the holidays that would appear in a complete Christian calendar. Vall-islamic-calendar-holidays *If nil, show only major holidays from the Islamic calendar. This means only those Islamic holidays that appear on secular calendars. If t, show all the holidays that would appear in a complete Islamic calendar. Vcalendar-load-hook *List of functions to be called after the calendar is first loaded. This is the place to add key bindings to `calendar-mode-map'. Vinitial-calendar-window-hook *List of functions to be called when the calendar window is first opened. The functions invoked are called after the calendar window is opened, but once opened is never called again. Leaving the calendar with the `q' command and reentering it will cause these functions to be called again. Vtoday-visible-calendar-hook *List of functions called whenever the current date is visible. This can be used, for example, to replace today's date with asterisks; a function `calendar-star-date' is included for this purpose: (setq today-visible-calendar-hook 'calendar-star-date) It can also be used to mark the current date with `calendar-today-marker'; a function is also provided for this: (setq today-visible-calendar-hook 'calendar-mark-today) The corresponding variable `today-invisible-calendar-hook' is the list of functions called when the calendar function was called when the current date is not visible in the window. Other than the use of the provided functions, the changing of any characters in the calendar buffer by the hooks may cause the failure of the functions that move by days and weeks. Vtoday-invisible-calendar-hook *List of functions called whenever the current date is not visible. The corresponding variable `today-visible-calendar-hook' is the list of functions called when the calendar function was called when the current date is visible in the window. Other than the use of the provided functions, the changing of any characters in the calendar buffer by the hooks may cause the failure of the functions that move by days and weeks. Vdiary-file *Name of the file in which one's personal diary of dates is kept. The file's entries are lines in any of the forms MONTH/DAY MONTH/DAY/YEAR MONTHNAME DAY MONTHNAME DAY, YEAR DAYNAME at the beginning of the line; the remainder of the line is the diary entry string for that date. MONTH and DAY are one or two digit numbers, YEAR is a number and may be written in full or abbreviated to the final two digits. If the date does not contain a year, it is generic and applies to any year. DAYNAME entries apply to any date on which is on that day of the week. MONTHNAME and DAYNAME can be spelled in full, abbreviated to three characters (with or without a period), capitalized or not. Any of DAY, MONTH, or MONTHNAME, YEAR can be `*' which matches any day, month, or year, respectively. The European style (in which the day precedes the month) can be used instead, if you execute `european-calendar' when in the calendar, or set `european-calendar-style' to t in your .emacs file. The European forms are DAY/MONTH DAY/MONTH/YEAR DAY MONTHNAME DAY MONTHNAME YEAR DAYNAME To revert to the default American style from the European style, execute `american-calendar' in the calendar. A diary entry can be preceded by the character `diary-nonmarking-symbol' (ordinarily `&') to make that entry nonmarking--that is, it will not be marked on dates in the calendar window but will appear in a diary window. Multiline diary entries are made by indenting lines after the first with either a TAB or one or more spaces. Lines not in one the above formats are ignored. Here are some sample diary entries (in the default American style): 12/22/1988 Twentieth wedding anniversary!! &1/1. Happy New Year! 10/22 Ruth's birthday. 21: Payday Tuesday--weekly meeting with grad students at 10am Supowit, Shen, Bitner, and Kapoor to attend. 1/13/89 Friday the thirteenth!! &thu 4pm squash game with Lloyd. mar 16 Dad's birthday April 15, 1989 Income tax due. &* 15 time cards due. If the first line of a diary entry consists only of the date or day name with no trailing blanks or punctuation, then that line is not displayed in the diary window; only the continuation lines is shown. For example, the single diary entry 02/11/1989 Bill Blattner visits Princeton today 2pm Cognitive Studies Committee meeting 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative' 4:00pm Jamie Tappenden 7:30pm Dinner at George and Ed's for Alan Ryan 7:30-10:00pm dance at Stewart Country Day School will appear in the diary window without the date line at the beginning. This facility allows the diary window to look neater, but can cause confusion if used with more than one day's entries displayed. Diary entries can be based on Lisp sexps. For example, the diary entry %%(diary-block 11 1 1990 11 10 1990) Vacation causes the diary entry "Vacation" to appear from November 1 through November 10, 1990. Other functions available are `diary-float', `diary-anniversary', `diary-cyclic', `diary-day-of-year', `diary-iso-date', `diary-french-date', `diary-hebrew-date', `diary-islamic-date', `diary-mayan-date', `diary-yahrzeit', `diary-sunrise-sunset', `diary-phases-of-moon', `diary-parasha', `diary-omer', `diary-rosh-hodesh', and `diary-sabbath-candles'. See the documentation for the function `list-sexp-diary-entries' for more details. Diary entries based on the Hebrew and/or the Islamic calendar are also possible, but because these are somewhat slow, they are ignored unless you set the `nongregorian-diary-listing-hook' and the `nongregorian-diary-marking-hook' appropriately. See the documentation for these functions for details. Diary files can contain directives to include the contents of other files; for details, see the documentation for the variable `list-diary-entries-hook'. Vdiary-nonmarking-symbol *Symbol indicating that a diary entry is not to be marked in the calendar. Vhebrew-diary-entry-symbol *Symbol indicating a diary entry according to the Hebrew calendar. Vislamic-diary-entry-symbol *Symbol indicating a diary entry according to the Islamic calendar. Vdiary-include-string *The string indicating inclusion of another file of diary entries. See the documentation for the function `include-other-diary-files'. Vsexp-diary-entry-symbol *The string used to indicate a sexp diary entry in diary-file. See the documentation for the function `list-sexp-diary-entries'. Vabbreviated-calendar-year *Interpret a two-digit year DD in a diary entry as either 19DD or 20DD. For the Gregorian calendar; similarly for the Hebrew and Islamic calendars. If this variable is nil, years must be written in full. Veuropean-calendar-style *Use the European style of dates in the diary and in any displays. If this variable is t, a date 1/2/1990 would be interpreted as February 1, 1990. The accepted European date styles are DAY/MONTH DAY/MONTH/YEAR DAY MONTHNAME DAY MONTHNAME YEAR DAYNAME Names can be capitalized or not, written in full, or abbreviated to three characters with or without a period. Vamerican-date-diary-pattern *List of pseudo-patterns describing the American patterns of date used. See the documentation of `diary-date-forms' for an explanation. Veuropean-date-diary-pattern *List of pseudo-patterns describing the European patterns of date used. See the documentation of `diary-date-forms' for an explanation. Veuropean-calendar-display-form *Pseudo-pattern governing the way a date appears in the European style. See the documentation of calendar-date-display-form for an explanation. Vamerican-calendar-display-form *Pseudo-pattern governing the way a date appears in the American style. See the documentation of `calendar-date-display-form' for an explanation. Vprint-diary-entries-hook *List of functions called after a temporary diary buffer is prepared. The buffer shows only the diary entries currently visible in the diary buffer. The default just does the printing. Other uses might include, for example, rearranging the lines into order by day and time, saving the buffer instead of deleting it, or changing the function used to do the printing. Vlist-diary-entries-hook *List of functions called after diary file is culled for relevant entries. It is to be used for diary entries that are not found in the diary file. A function `include-other-diary-files' is provided for use as the value of this hook. This function enables you to use shared diary files together with your own. The files included are specified in the diary file by lines of the form #include "filename" This is recursive; that is, #include directives in files thus included are obeyed. You can change the "#include" to some other string by changing the variable `diary-include-string'. When you use `include-other-diary-files' as part of the list-diary-entries-hook, you will probably also want to use the function `mark-included-diary-files' as part of `mark-diary-entries-hook'. For example, you could use (setq list-diary-entries-hook '(include-other-diary-files sort-diary-entries)) (setq diary-display-hook 'fancy-diary-display) in your `.emacs' file to cause the fancy diary buffer to be displayed with diary entries from various included files, each day's entries sorted into lexicographic order. Vdiary-hook *List of functions called after the display of the diary. Can be used for appointment notification. Vdiary-display-hook *List of functions that handle the display of the diary. If nil (the default), `simple-diary-display' is used. Use `ignore' for no diary display. Ordinarily, this just displays the diary buffer (with holidays indicated in the mode line), if there are any relevant entries. At the time these functions are called, the variable `diary-entries-list' is a list, in order by date, of all relevant diary entries in the form of ((MONTH DAY YEAR) STRING), where string is the diary entry for the given date. This can be used, for example, a different buffer for display (perhaps combined with holidays), or produce hard copy output. A function `fancy-diary-display' is provided as an alternative choice for this hook; this function prepares a special noneditable diary buffer with the relevant diary entries that has neat day-by-day arrangement with headings. The fancy diary buffer will show the holidays unless the variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy diary buffer will not show days for which there are no diary entries, even if that day is a holiday; if you want such days to be shown in the fancy diary buffer, set the variable `diary-list-include-blanks' to t. Vnongregorian-diary-listing-hook *List of functions called for listing diary file and included files. As the files are processed for diary entries, these functions are used to cull relevant entries. You can use either or both of `list-hebrew-diary-entries' and `list-islamic-diary-entries'. The documentation for these functions describes the style of such diary entries. Vmark-diary-entries-hook *List of functions called after marking diary entries in the calendar. A function `mark-included-diary-files' is also provided for use as the mark-diary-entries-hook; it enables you to use shared diary files together with your own. The files included are specified in the diary file by lines of the form #include "filename" This is recursive; that is, #include directives in files thus included are obeyed. You can change the "#include" to some other string by changing the variable `diary-include-string'. When you use `mark-included-diary-files' as part of the mark-diary-entries-hook, you will probably also want to use the function `include-other-diary-files' as part of `list-diary-entries-hook'. Vnongregorian-diary-marking-hook *List of functions called for marking diary file and included files. As the files are processed for diary entries, these functions are used to cull relevant entries. You can use either or both of `mark-hebrew-diary-entries' and `mark-islamic-diary-entries'. The documentation for these functions describes the style of such diary entries. Vdiary-list-include-blanks *If nil, do not include days with no diary entry in the list of diary entries. Such days will then not be shown in the the fancy diary buffer, even if they are holidays. Vholidays-in-diary-buffer *Non-nil means include holidays in the diary display. The holidays appear in the mode line of the diary buffer, or in the fancy diary buffer next to the date. This slows down the diary functions somewhat; setting it to nil makes the diary display faster. Vgeneral-holidays *General holidays. Default value is for the United States. See the documentation for `calendar-holidays' for details. Vlocal-holidays *Local holidays. See the documentation for `calendar-holidays' for details. Vother-holidays *User defined holidays. See the documentation for `calendar-holidays' for details. Vhebrew-holidays *Jewish holidays. See the documentation for `calendar-holidays' for details. Vchristian-holidays *Christian holidays. See the documentation for `calendar-holidays' for details. Vislamic-holidays *Islamic holidays. See the documentation for `calendar-holidays' for details. Vsolar-holidays *Sun-related holidays. See the documentation for `calendar-holidays' for details. Fcalendar Display a three-month calendar in another window. The three months appear side by side, with the current month in the middle surrounded by the previous and next months. The cursor is put on today's date. If called with an optional prefix argument, prompts for month and year. This function is suitable for execution in a .emacs file; appropriate setting of the variable `view-diary-entries-initially' will cause the diary entries for the current date to be displayed in another window. The value of the variable `number-of-diary-entries' controls the number of days of diary entries displayed upon initial display of the calendar. An optional prefix argument ARG causes the calendar displayed to be ARG months in the future if ARG is positive or in the past if ARG is negative; in this case the cursor goes on the first day of the month. Once in the calendar window, future or past months can be moved into view. Arbitrary months can be displayed, or the calendar can be scrolled forward or backward. The cursor can be moved forward or backward by one day, one week, one month, or one year. All of these commands take prefix arguments which, when negative, cause movement in the opposite direction. For convenience, the digit keys and the minus sign are automatically prefixes. The window is replotted as necessary to display the desired date. Diary entries can be marked on the calendar or displayed in another window. Use M-x describe-mode for details of the key bindings in the calendar window. The Gregorian calendar is assumed. After loading the calendar, the hooks given by the variable `calendar-load-hook' are run. This is the place to add key bindings to the calendar-mode-map. After preparing the calendar window initially, the hooks given by the variable `initial-calendar-window-hook' are run. The hooks given by the variable `today-visible-calendar-hook' are run everytime the calendar window gets scrolled, if the current date is visible in the window. If it is not visible, the hooks given by the variable `today-invisible-calendar-hook' are run. Thus, for example, setting `today-visible-calendar-hook' to 'calendar-star-date will cause today's date to be replaced by asterisks to highlight it whenever it is in the window. Flist-yahrzeit-dates List Yahrzeit dates for *Gregorian* DEATH-DATE from START-YEAR to END-YEAR. When called interactively from the calendar window, the date of death is taken from the cursor position. Fdiary Generate the diary window for ARG days starting with the current date. If no argument is provided, the number of days of diary entries is governed by the variable `number-of-diary-entries'. This function is suitable for execution in a `.emacs' file. Fholidays Display the holidays for last month, this month, and next month. If called with an optional prefix argument, prompts for month and year. This function is suitable for execution in a .emacs file. Fphases-of-moon Display the quarters of the moon for last month, this month, and next month. If called with an optional prefix argument, prompts for month and year. This function is suitable for execution in a .emacs file. Vcalendar-time-display-form *The pseudo-pattern that governs the way a time of day is formatted. A pseudo-pattern is a list of expressions that can involve the keywords `12-hours', `24-hours', and `minutes', all numbers in string form, and `am-pm' and `time-zone', both alphabetic strings. For example, the form '(24-hours ":" minutes (if time-zone " (") time-zone (if time-zone ")")) would give military-style times like `21:07 (UTC)'. Vcalendar-latitude *Latitude of `calendar-location-name' in degrees. The value can be either a decimal fraction (one place of accuracy is sufficient), + north, - south, such as 40.7 for New York City, or the value can be a vector [degrees minutes north/south] such as [40 50 north] for New York City. This variable should be set in site-local.el. Vcalendar-longitude *Longitude of `calendar-location-name' in degrees. The value can be either a decimal fraction (one place of accuracy is sufficient), + east, - west, such as -73.9 for New York City, or the value can be a vector [degrees minutes east/west] such as [73 55 west] for New York City. This variable should be set in site-local.el. Vcalendar-location-name *Expression evaluating to name of `calendar-longitude', calendar-latitude'. For example, "New York City". Default value is just the latitude, longitude pair. This variable should be set in site-local.el. Fsunrise-sunset Local time of sunrise and sunset for today. Accurate to +/- 2 minutes. If called with an optional prefix argument, prompt for date. If called with an optional double prefix argument, prompt for longitude, latitude, time zone, and date, and always use standard time. This function is suitable for execution in a .emacs file. Fsolar-equinoxes-solstices Date and time of equinoxes and solstices, if visible in the calendar window. Requires floating point. Fmake-comint Make a comint process NAME in a buffer, running PROGRAM. The name of the buffer is made by surrounding NAME with `*'s. If there is already a running process in that buffer, it is not restarted. Optional third arg STARTFILE is the name of a file to send the contents of to the process. Any more args are arguments to PROGRAM. Fcomint-run Run PROGRAM in a comint buffer and switch to it. The buffer name is made by surrounding the file name of PROGRAM with `*'s. The file name is used to make a symbol name, such as `comint-sh-hook', and any hooks on this symbol are run in the buffer. See `make-comint' and `comint-exec'. Fcomint-dynamic-complete Dynamically perform completion at point. Calls the functions in `comint-dynamic-complete-functions' to perform completion until a function returns non-nil, at which point completion is assumed to have occurred. Fcomint-dynamic-list-completions List in help buffer sorted COMPLETIONS. Typing SPC flushes the help buffer. Vgdb-command-name Pathname for executing gdb. Fgdb Run gdb on program FILE in buffer *gdb-FILE*. The directory containing FILE becomes the initial working directory and source-file directory for GDB. If you wish to change this, use the GDB commands `cd DIR' and `directory'. Fgdbsrc Activates a gdb session with gdbsrc-mode turned on. A numeric prefix argument can be used to specify a running process to attach, and a non-numeric prefix argument will cause you to be prompted for a core file to debug. Fsdb Run sdb on program FILE in buffer *gud-FILE*. The directory containing FILE becomes the initial working directory and source-file directory for your debugger. Fdbx Run dbx on program FILE in buffer *gud-FILE*. The directory containing FILE becomes the initial working directory and source-file directory for your debugger. Fxdb Run xdb on program FILE in buffer *gud-FILE*. The directory containing FILE becomes the initial working directory and source-file directory for your debugger. You can set the variable 'gud-xdb-directories' to a list of program source directories if your program contains sources from more than one directory. Fperldb Run perldb on program FILE in buffer *gud-FILE*. The directory containing FILE becomes the initial working directory and source-file directory for your debugger. Frlogin Open a network login connection to HOST via the `rlogin' program. Input is sent line-at-a-time to the remote connection. Communication with the remote host is recorded in a buffer `*rlogin-HOST*' (or `*rlogin-USER@HOST*' if the remote username differs). If a prefix argument is given and the buffer `*rlogin-HOST*' already exists, a new buffer with a different connection will be made. When called from a program, if the optional second argument is a string or buffer, it names the buffer to use. The variable `rlogin-program' contains the name of the actual program to run. It can be a relative or absolute path. The variable `rlogin-explicit-args' is a list of arguments to give to the rlogin when starting. They are added after any arguments given in INPUT-ARGS. If the default value of `rlogin-directory-tracking-mode' is t, then the default directory in that buffer is set to a remote (FTP) file name to access your home directory on the remote machine. Occasionally this causes an error, if you cannot access the home directory on that machine. This error is harmless as long as you don't try to use that default directory. If `rlogin-directory-tracking-mode' is neither t nor nil, then the default directory is initially set up to your (local) home directory. This is useful if the remote machine and your local machine share the same files via NFS. This is the default. If you wish to change directory tracking styles during a session, use the function `rlogin-directory-tracking-mode' rather than simply setting the variable. Vshell-prompt-pattern Regexp to match prompts in the inferior shell. Defaults to "^[^#$%>\n]*[#$%>] *", which works pretty well. This variable is used to initialise `comint-prompt-regexp' in the shell buffer. The pattern should probably not match more than one line. If it does, shell-mode may become confused trying to distinguish prompt from input on lines which don't start with a prompt. This is a fine thing to set in your `.emacs' file. Fshell Run an inferior shell, with I/O through buffer *shell*. If buffer exists but shell process is not running, make new shell. If buffer exists and shell process is running, just switch to buffer `*shell*'. Program used comes from variable `explicit-shell-file-name', or (if that is nil) from the ESHELL environment variable, or else from SHELL if there is no ESHELL. If a file `~/.emacs_SHELLNAME' exists, it is given as initial input (Note that this may lose due to a timing error if the shell discards input when it starts up.) The buffer is put in Shell mode, giving commands for sending input and controlling the subjobs of the shell. See `shell-mode'. See also the variable `shell-prompt-pattern'. The shell file name (sans directories) is used to make a symbol name such as `explicit-csh-args'. If that symbol is a variable, its value is used as a list of arguments when invoking the shell. Otherwise, one argument `-i' is passed to the shell. (Type \[describe-mode] in the shell buffer for a list of commands.) Ftelnet Open a network login connection to host named HOST (a string). With a prefix argument, prompts for the port name or number as well. Communication with HOST is recorded in a buffer *HOST-telnet*. Normally input is edited in Emacs and sent a line at a time. See also `\[rsh]'. Frsh Open a network login connection to host named HOST (a string). Communication with HOST is recorded in a buffer *HOST-rsh*. Normally input is edited in Emacs and sent a line at a time. See also `\[telnet]'. Vange-ftp-path-format *Format of a fully expanded remote pathname. This is a cons (REGEXP . (HOST USER PATH)), where REGEXP is a regular expression matching the full remote pathname, and HOST, USER, and PATH are the numbers of parenthesized expressions in REGEXP for the components (in that order). Vdired-listing-switches *Switches passed to ls for dired. MUST contain the `l' option. Can contain even `F', `b', `i' and `s'. Vdired-chown-program *Name of chown command (usully `chown' or `/etc/chown'). Vdired-ls-program *Absolute or relative name of the ls program used by dired. Vdired-ls-F-marks-symlinks *Informs dired about how ls -lF marks symbolic links. Set this to t if `dired-ls-program' with -lF marks the symbolic link itself with a trailing @ (usually the case under Ultrix). Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to nil, if it gives `bar@ -> foo', set it to t. Dired checks if there is really a @ appended. Thus, if you have a marking ls program on one host and a non-marking on another host, and don't care about symbolic links which really end in a @, you can always set this variable to t. Vdired-trivial-filenames *Regexp of files to skip when moving point to the first file of a new directory listing. Nil means move to the subdir line, t means move to first file. Vdired-keep-marker-move If t, moved marked files are marked if their originals were. If a character, those files (marked or not) are marked with that character. Vdired-keep-marker-copy If t, copied files are marked if their source files were. If a character, those files are always marked with that character. Vdired-keep-marker-hardlink If t, hard-linked files are marked if the linked-to files were. If a character, those files are always marked with that character. Vdired-keep-marker-symlink If t, symlinked marked files are marked if the linked-to files were. If a character, those files are always marked with that character. Vdired-dwim-target *If non-nil, dired tries to guess a default target directory: If there is a dired buffer displayed in the next window, use its current subdir, instead of the current subdir of this dired buffer. The target is used in the prompt for file copy, move etc. Vdired-copy-preserve-time *If non-nil, Dired preserves the last-modified time in a file copy. (This works on only some systems.)\<dired-mode-map> Use `\[dired-do-copy]' with a zero prefix argument to toggle its value. Fdired "Edit" directory DIRNAME--delete, rename, print, etc. some files in it. With an optional prefix argument you can specify the ls SWITCHES that are used. Dired displays a list of files in DIRNAME (which may also have shell wildcards appended to select certain files). You can move around in it with the usual commands. You can flag files for deletion with \<dired-mode-map>\[dired-flag-file-deleted] and then delete them by typing \[dired-do-deletions]. Type \[describe-mode] after entering dired for more info. If DIRNAME is already in a dired buffer, that buffer is used without refresh. Fdired-other-window "Edit" directory DIRNAME. Like `dired' but selects in another window. Fdired-noselect Like `dired' but returns the dired buffer as value, does not select it. Fdired-cwd-make-magic Modify COMMAND so that it's working directory is the current dired directory. This works by binding `default-directory' to `(default-directory)'s value. See also function `default-directory'. Fdired-do-rename-numeric Rename all marked (or next ARG) files using numbers. You are prompted for a format string, e.g "part_%d_of_8", and a starting number, e.g. 1. If there are 8 marked files, this example will rename them to part_1_of_8 part_2_of_8 ... part_8_of_8 Fdired-do-rename-list Rename all marked (or next ARG) files using elements from LIST. You are prompted for a format string, e.g "x_%s", and the list, e.g. '(foo bar zod). This example will rename the marked files to x_foo x_bar x_zod It is an error if LIST has not as many elements as there are files. Fdired-rcs-mark-rcs-locked-files Mark all files that are under RCS control and RCS-locked. With prefix argument, unflag all those files. Mentions RCS files for which a working file was not found in this buffer. Type \[dired-why] to see them again. Fdired-rcs-mark-rcs-files Mark all files that are under RCS control. With prefix argument, unflag all those files. Mentions RCS files for which a working file was not found in this buffer. Type \[dired-why] to see them again. Fdired-extra-startup Automatically put on dired-mode-hook to get extra dired features: \<dired-mode-map> \[dired-vm] -- VM on folder \[dired-rmail] -- Rmail on folder \[dired-do-insert-subdir] -- insert all marked subdirs \[dired-do-find-file] -- visit all marked files simultaneously \[dired-set-marker-char], \[dired-restore-marker-char] -- change and display dired-marker-char dynamically. \[dired-omit-toggle] -- toggle omitting of files \[dired-mark-sexp] -- mark by lisp expression \[dired-do-unmark] -- replace existing marker with another. \[dired-mark-rcs-files] -- mark all RCS controlled files \[dired-mark-files-compilation-buffer] -- mark compilation files \[dired-copy-filename-as-kill] -- copy the file or subdir names into the kill ring. You can feed it to other commands using \[yank]. For more features, see variables dired-omit-files dired-omit-extenstions dired-dangerous-shell-command dired-mark-keys dired-local-variables-file dired-find-subdir dired-guess-have-gnutar dired-auto-shell-command-alist See also functions dired-sort-on-size dired-do-relsymlink dired-flag-extension dired-virtual dired-jump-back dired-jump-back-other-window Vfind-ls-option *Option to `find' to produce an `ls -l'-type listing. Vfind-grep-options *Option to grep to be as silent as possible. On Berkeley systems, this is `-s', for others it seems impossible to suppress all output, so `-l' is used to print nothing more than the file name. Vfind-dired-multiple-buffers *If non-nil, generates a new buffer for each find Ffind-dired Run `find' and go into dired-mode on a buffer of the output. The command run (after changing into DIR) is find . $ ARGS $ -ls Ffind-name-dired Search DIR recursively for files matching the globbing pattern PATTERN, and run dired on those files. PATTERN is a shell wildcard (not an Emacs regexp) and need not be quoted. The command run (after changing into DIR) is find . -name 'PATTERN' -ls Ffind-grep-dired Find files in DIR containing a regexp ARG and start Dired on output. The command run (after changing into DIR) is find . (-type f -exec test -r {} \;-exec grep -s ARG {} \; -ls Thus ARG can also contain additional grep options. Fedebug-eval-top-level-form Evaluate a top level form, such as defun or defmacro. This is like eval-defun, but with edebug calls. Print its name in the minibuffer and leave point where it is, or if an error occurs, leave point after it with mark at the original point. Vglobal-edebug-prefix Prefix key for global edebug commands, available from any buffer. Fediff-show-registry Display Ediff's registry. Felectric-buffer-list Pops up a buffer describing the set of Emacs buffers. Vaguely like ITS lunar select buffer; combining typeoutoid buffer listing with menuoid buffer selection. If the very next character typed is a space then the buffer list window disappears. Otherwise, one may move around in the buffer list window, marking buffers to be selected, saved or deleted. To exit and select a new buffer, type a space when the cursor is on the appropriate line of the buffer-list window. Other commands are much like those of buffer-menu-mode. Calls value of `electric-buffer-menu-mode-hook' on entry if non-nil. \{electric-buffer-menu-mode-map} FElectric-command-history-redo-expression Edit current history line in minibuffer and execute result. With prefix argument NOCONFIRM, execute current line as-is without editing. Felectric-command-history \<electric-history-map>Major mode for examining and redoing commands from `command-history'. This pops up a window with the Command History listing. The number of command listed is controlled by `list-command-history-max'. The command history is filtered by `list-command-history-filter' if non-nil. Combines typeout Command History list window with menu like selection of an expression from the history for re-evaluation in the *original* buffer. The history displayed is filtered by `list-command-history-filter' if non-nil. This pops up a window with the Command History listing. If the very next character typed is Space, the listing is killed and the previous window configuration is restored. Otherwise, you can browse in the Command History with Return moving down and Delete moving up, possibly selecting an expression to be redone with Space or quitting with `Q'. Like Emacs-Lisp mode except that characters do not insert themselves and Tab and Linefeed do not indent. Instead these commands are provided: \{electric-history-map} Calls the value of `electric-command-history-hook' if that is non-nil. The Command History listing is recomputed each time this mode is invoked. Fevi Start vi emulation in this buffer. Fset-gosmacs-bindings Rebind some keys globally to make GNU Emacs resemble Gosling Emacs. Use \[set-gnu-bindings] to restore previous global bindings. Fconvert-mocklisp-buffer Convert buffer of Mocklisp code to real Lisp that GNU Emacs can run. Fteco-command Read and execute a Teco command string. Ftpu-edt-on Turn on TPU/edt emulation. Fmake-term Make a term process NAME in a buffer, running PROGRAM. The name of the buffer is made by surrounding NAME with `*'s. If there is already a running process in that buffer, it is not restarted. Optional third arg STARTFILE is the name of a file to send the contents of to the process. Any more args are arguments to PROGRAM. Fterm Start a terminal-emulator in a new buffer. Ftgdb Run gdb on program FILE in buffer *tgud-FILE*. The directory containing FILE becomes the initial working directory and source-file directory for your debugger. Ftsdb Run sdb on program FILE in buffer *tgud-FILE*. The directory containing FILE becomes the initial working directory and source-file directory for your debugger. Ftdbx Run dbx on program FILE in buffer *tgud-FILE*. The directory containing FILE becomes the initial working directory and source-file directory for your debugger. Ftxdb Run xdb on program FILE in buffer *tgud-FILE*. The directory containing FILE becomes the initial working directory and source-file directory for your debugger. You can set the variable 'tgud-xdb-directories' to a list of program source directories if your program contains sources from more than one directory. Ftperldb Run perldb on program FILE in buffer *tgud-FILE*. The directory containing FILE becomes the initial working directory and source-file directory for your debugger. Vtshell-prompt-pattern Regexp to match prompts in the inferior shell. Defaults to "^[^#$%>\n]*[#$%>] *", which works pretty well. This variable is used to initialise `term-prompt-regexp' in the shell buffer. The pattern should probably not match more than one line. If it does, tshell-mode may become confused trying to distinguish prompt from input on lines which don't start with a prompt. This is a fine thing to set in your `.emacs' file. Ftshell Run an inferior shell, with I/O through buffer *shell*. If buffer exists but shell process is not running, make new shell. If buffer exists and shell process is running, just switch to buffer `*shell*'. Program used comes from variable `explicit-shell-file-name', or (if that is nil) from the ESHELL environment variable, or else from SHELL if there is no ESHELL. If a file `~/.emacs_SHELLNAME' exists, it is given as initial input (Note that this may lose due to a timing error if the shell discards input when it starts up.) The buffer is put in Tshell mode, giving commands for sending input and controlling the subjobs of the shell. See `tshell-mode'. See also the variable `tshell-prompt-pattern'. The shell file name (sans directories) is used to make a symbol name such as `explicit-csh-args'. If that symbol is a variable, its value is used as a list of arguments when invoking the shell. Otherwise, one argument `-i' is passed to the shell. (Type \[describe-mode] in the shell buffer for a list of commands.) Fblackbox Play blackbox. Optional prefix argument is the number of balls; the default is 4. What is blackbox? Blackbox is a game of hide and seek played on an 8 by 8 grid (the Blackbox). Your opponent (Emacs, in this case) has hidden several balls (usually 4) within this box. By shooting rays into the box and observing where they emerge it is possible to deduce the positions of the hidden balls. The fewer rays you use to find the balls, the lower your score. Overview of play: \<blackbox-mode-map>To play blackbox, type \[blackbox]. An optional prefix argument specifies the number of balls to be hidden in the box; the default is four. The cursor can be moved around the box with the standard cursor movement keys. To shoot a ray, move the cursor to the edge of the box and press SPC. The result will be determined and the playfield updated. You may place or remove balls in the box by moving the cursor into the box and pressing \[bb-romp]. When you think the configuration of balls you have placed is correct, press \[bb-done]. You will be informed whether you are correct or not, and be given your score. Your score is the number of letters and numbers around the outside of the box plus five for each incorrectly placed ball. If you placed any balls incorrectly, they will be indicated with `x', and their actual positions indicated with `o'. Details: There are three possible outcomes for each ray you send into the box: Detour: the ray is deflected and emerges somewhere other than where you sent it in. On the playfield, detours are denoted by matching pairs of numbers -- one where the ray went in, and the other where it came out. Reflection: the ray is reflected and emerges in the same place it was sent in. On the playfield, reflections are denoted by the letter `R'. Hit: the ray strikes a ball directly and is absorbed. It does not emerge from the box. On the playfield, hits are denoted by the letter `H'. The rules for how balls deflect rays are simple and are best shown by example. As a ray approaches a ball it is deflected ninety degrees. Rays can be deflected multiple times. In the diagrams below, the dashes represent empty box locations and the letter `O' represents a ball. The entrance and exit points of each ray are marked with numbers as described under "Detour" above. Note that the entrance and exit points are always interchangeable. `*' denotes the path taken by the ray. Note carefully the relative positions of the ball and the ninety degree deflection it causes. 1 - * - - - - - - - - - - - - - - - - - - - - - - - * - - - - - - - - - - - - - - - - - - - - - - 1 * * - - - - - - - - - - - - - - - O - - - - O - - - O - - - - - - - O - - - - - - - * * * * - - - - - - - - - - - - - * * * * * 2 3 * * * - - * - - - - - - - - - - - - - * - - - - - - - O - * - - - - - - - - - - - - - * - - - - - - - - * * - - - - - - - - - - - - - * - - - - - - - - * - O - 2 3 As mentioned above, a reflection occurs when a ray emerges from the same point it was sent in. This can happen in several ways: - - - - - - - - - - - - - - - - - - - - - - - - - - - - O - - - - - O - O - - - - - - - - - - - R * * * * - - - - - - - * - - - - O - - - - - - - - - - - O - - - - - - * - - - - R - - - - - - - - - - - - - - - - - - - * - - - - - - - - - - - - - - - - - - - - - - - * - - - - - - - - - - - - - - - - - - - - R * * * * - - - - - - - - - - - - - - - - - - - - - - - - O - - - - - - - - - - - In the first example, the ray is deflected downwards by the upper ball, then left by the lower ball, and finally retraces its path to its point of origin. The second example is similar. The third example is a bit anomalous but can be rationalized by realizing the ray never gets a chance to get into the box. Alternatively, the ray can be thought of as being deflected downwards and immediately emerging from the box. A hit occurs when a ray runs straight into a ball: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - O - - - - - - - - - - - - - - - O - - - H * * * * - - - - - - - - - - - - H * * * * O - - - - - - * - - - - - - - - - - - - - - - - O - - - - - - O - - - - H * * * O - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Be sure to compare the second example of a hit with the first example of a reflection. Fconx-buffer Absorb the text in the current buffer into the tree. Fconx-region Absorb the text in the current region into the tree. Fconx Generate some random sentences in the *conx* buffer. Fconx-load Load in a CONX database written by the \[conx-save] command. This clears the database currently in memory. Fcookie Return a random phrase from PHRASE-FILE. When the phrase file is read in, display STARTMSG at beginning of load, ENDMSG at end. Fcookie-insert Insert random phrases from PHRASE-FILE; COUNT of them. When the phrase file is read in, display STARTMSG at beginning of load, ENDMSG at end. Fcookie-snarf Reads in the PHRASE-FILE, returns it as a vector of strings. Emit STARTMSG and ENDMSG before and after. Caches the result; second and subsequent calls on the same file won't go to disk. Fshuffle-vector Randomly permute the elements of VECTOR (all permutations equally likely) Fdissociated-press Dissociate the text of the current buffer. Output goes in buffer named *Dissociation*, which is redisplayed each time text is added to it. Every so often the user must say whether to continue. If ARG is positive, require ARG chars of continuity. If ARG is negative, require -ARG words of continuity. Default is 2. Fdoctor Switch to *doctor* buffer and start giving psychotherapy. Fdunnet Switch to *dungeon* buffer and start game. Fflame Generate ARG (default 1) sentences of half-crazed gibberish. Fgomoku Start a Gomoku game between you and Emacs. If a game is in progress, this command allow you to resume it. If optional arguments N and M are given, an N by M board is used. You and Emacs play in turn by marking a free square. You mark it with X and Emacs marks it with O. The winner is the first to get five contiguous marks horizontally, vertically or in diagonal. You play by moving the cursor over the square you choose and hitting \<gomoku-mode-map>\[gomoku-human-plays]. Use \[describe-mode] for more info. Fhanoi Towers of Hanoi diversion. Argument is number of rings. Flife Run Conway's Life simulation. The starting pattern is randomly selected. Prefix arg (optional first arg non-nil from a program) is the number of seconds to sleep between generations (this defaults to 1). Fmpuz Multiplication puzzle with GNU Emacs. Fspook Adds that special touch of class to your outgoing mail. Fyow Return or display a random Zippy quotation. With prefix arg, insert it. Finsert-zippyism Prompt with completion for a known Zippy quotation, and insert it at point. Fpsychoanalyze-pinhead Zippy goes to the analyst. Fgnus Read network news. If optional argument CONFIRM is non-nil, ask NNTP server. Fgnus-batch-kill Run batched KILL. Usage: emacs -batch -l gnus -f gnus-batch-kill NEWSGROUP ... Fgnus-post-news Begin editing a new USENET news article to be posted. Type \[describe-mode] once editing the article to get a list of commands. Fgnusutil-add-group Specify that news group NAME is encoded in CODING-SYSTEM. Subject and article buffers are automatically converted appropriately. If CODING-SYSTEM is cons, the car/cdr part is regarded as coding-system for read/write respectively. Fgnusutil-initialize Do several settings for GNUS to enable automatic code conversion. Fhtml-mode Major mode for editing HTML hypertext documents. Special commands:\{html-mode-map} Turning on html-mode calls the value of the variable html-mode-hook, if that value is non-nil. More extensive documentation is available in the file 'html-mode.el'. The latest (possibly unstable) version of this file will always be available on anonymous FTP server ftp.ncsa.uiuc.edu in /Mosaic/elisp. Fhtml-view-start-mosaic Start Mosaic. Fhtml-view-view-file View an html file with Mosaic. Fhtml-view-view-buffer View html buffer with Mosaic. If BUFFER-TO-VIEW is nil, then the current buffer is used. Fhtml-view-goto-url Goto an URL in Mosaic. Fhtml-view-get-display Get the display for Mosaic. Ftmpl-expand-templates-in-region Expand the templates in the region from BEGIN to END. If BEGIN and and are nil, then the current region is used. Ftmpl-expand-templates-in-buffer Expand all templates in the current buffer. Fhmail:compose Compose mail with ADDRESS and evaluation of EXPR. Optional SUBJECT and HELP message may also be given. Fsmart-info Walks through Info documentation networks using one key or mouse key. If key is pressed within: (1) the first line of an Info Menu Entry or Cross Reference, the desired node is found; (2) the Up, Next, or Previous entries of a Node Header (first line), the desired node is found; (3) the File entry of a Node Header (first line), the 'Top' node within that file is found; (4) at the end of the current node, the Next node is found (this will descend subtrees if the function 'Info-global-next' is bound); (5) anywhere else (e.g. at the end of a line), the current node entry is scrolled up one windowful. Returns t if key is pressed within an Info Node Header, Cross Reference, or a Menu; otherwise returns nil. Fsmart-info-assist Walks through Info documentation networks using one assist-key or mouse assist-key. If assist-key is pressed within: (1) the first line of an Info Menu Entry or Cross Reference, the desired node is found; (2) the Up, Next, or Previous entries of a Node Header (first line), the last node in the history list is found; (3) the File entry of a Node Header (first line), the 'DIR' root-level node is found; (4) at the end of the current node, the Previous node is found (this will return from subtrees if the function 'Info-global-prev is bound); (5) anywhere else (e.g. at the end of a line), the current node entry is scrolled down one windowful. Returns t if assist-key is pressed within an Info Node Header, Cross Reference, or a Menu; otherwise returns nil. FInfo-handle-in-note Follows an Info cross-reference. If point is within the first line of an Info note (cross-reference), follows cross-reference and returns t; otherwise returns nil. Fsmart-asm-at-tag-p Return assembly tag name that point is within, else nil. Fsmart-c-at-tag-p Return C tag name that point is within, else nil. Fsmart-c++ Jumps to the definition of optional C++ IDENTIFIER or the one at point. Optional second arg NEXT means jump to next matching C++ tag. It assumes that its caller has already checked that the key was pressed in an appropriate buffer and has moved the cursor to the selected buffer. If: (1) on a '#include' statement, the include file is displayed; Look for include file in directory lists 'smart-c-cpp-include-dirs' and 'smart-c-include-dirs'. (2) on a C++ identifier, the identifier definition is displayed, assuming the identifier is found within an 'etags' generated tag file in the current directory or any of its ancestor directories. (3) if 'smart-c-use-lib-man' is non-nil, the C++ identifier is recognized as a library symbol, and a man page is found for the identifier, then the man page is displayed. Fsmart-c++-oobr Jumps to the definition of selected C++ construct via OO-Browser support. Optional JUNK is ignored. Does nothing if the OO-Browser is not available. It assumes that its caller has already checked that the key was pressed in an appropriate buffer and has moved the cursor to the selected buffer. If key is pressed: (1) on a '#include' statement, the include file is displayed; Look for include file in directory lists 'smart-c-cpp-include-dirs' and 'smart-c-include-dirs'. (2) within a method declaration, its definition is displayed; (3) on a class name, the class definition is shown. (2) and (3) require that an OO-Browser Environment has been loaded with the {M-x br-env-load RTN} command. Fsmart-fortran-at-tag-p Return Fortran tag name that point is within, else nil. Fsmart-objc Jumps to the definition of optional Objective-C IDENTIFIER or the one at point. Optional second arg NEXT means jump to next matching Objective-C tag. It assumes that its caller has already checked that the key was pressed in an appropriate buffer and has moved the cursor to the selected buffer. If: (1) on a '#include' statement, the include file is displayed; Look for include file in directory lists 'smart-c-cpp-include-dirs' and 'smart-c-include-dirs'. (2) on an Objective-C identifier, the identifier definition is displayed, assuming the identifier is found within an 'etags' generated tag file in the current directory or any of its ancestor directories. (3) if 'smart-c-use-lib-man' is non-nil, the Objective-C identifier is recognized as a library symbol, and a man page is found for the identifier, then the man page is displayed. Fsmart-objc-oobr Jumps to the definition of selected Objective-C construct via OO-Browser support. Optional JUNK is ignored. Does nothing if the OO-Browser is not available. It assumes that its caller has already checked that the key was pressed in an appropriate buffer and has moved the cursor to the selected buffer. If key is pressed: (1) on a '#include' statement, the include file is displayed; Look for include file in directory lists 'smart-c-cpp-include-dirs' and 'smart-c-include-dirs'. (2) within a method declaration, its definition is displayed; (3) on a class name, the class definition is shown. (2) and (3) require that an OO-Browser Environment has been loaded with the {M-x br-env-load RTN} command. Fsmart-tags-file-path Expand relative FILE name by looking it up in the nearest tags file. Return FILE unchanged if it exists relative to the current directory or cannot be expanded via a tags file. Fsmart-tags-file Return appropriate tags file name for CURR-FILENAME or 'tags-file-name'. Fvar:append Appends to value held by VAR-SYMBOL-NAME, LIST-TO-ADD. Returns new value. If VAR-SYMBOL-NAME is unbound, it is set to LIST-TO-ADD. Often used to append to 'hook' variables. Fwconfig-add-by-name Saves the current window configuration under the string NAME. When called interactively and a window configuration already exists under NAME, confirms whether or not to replace it. Fwconfig-delete-by-name Deletes window configuration saved under NAME. Fwconfig-restore-by-name Restores window configuration saved under NAME. Fwconfig-delete-pop Replaces current window config with most recently saved config in ring. Then deletes this new configuration from the ring. Fwconfig-ring-save Saves the current window configuration onto the save ring. Use {\[wconfig-yank-pop]} to restore it at a later time. Fwconfig-yank-pop Replaces current window config with prefix arg Nth prior one in save ring. Interactively, default value of N = 1, meaning the last saved window configuration is displayed. The sequence of window configurations wraps around, so that after the oldest one comes the newest one. Frolo-logic Apply FUNC to all entries in optional IN-BUFS, display entries where FUNC is non-nil. If IN-BUFS is nil, 'rolo-file-list' is used. If optional COUNT-ONLY is non-nil, don't display entries, return count of matching entries only. If optional INCLUDE-SUB-ENTRIES flag is non-nil, FUNC will be applied across all sub-entries at once. Default is to apply FUNC to each entry and sub-entry separately. Entries are displayed with all of their sub-entries unless INCLUDE-SUB-ENTRIES is nil and optional NO-SUB-ENTRIES-OUT flag is non-nil. FUNC should use the free variables 'start' and 'end' which contain the limits of the region on which it should operate. Returns number of applications of FUNC that return non-nil. Frolo-add Adds a new entry in personal rolodex for NAME. Last name first is best, e.g. "Smith, John". With prefix argument, prompts for optional FILE to add entry within. NAME may be of the form: parent/child to insert child below a parent entry which begins with the parent string. Frolo-display-matches Display optional DISPLAY-BUF buffer of previously found rolodex matches. If DISPLAY-BUF is nil, use the value in 'rolo-display-buffer'. Second arg RETURN-TO-BUFFER is the buffer to leave point within after the display. Frolo-edit Edits a rolodex entry given by optional NAME within 'rolo-file-list'. With prefix argument, prompts for optional FILE to locate entry within. With no NAME arg, simply displays FILE or first entry in 'rolo-file-list' in an editable mode. NAME may be of the form: parent/child to edit child below a parent entry which begins with the parent string. Frolo-fgrep Display rolodex entries matching STRING. To a maximum of optional prefix arg MAX-MATCHES, in file(s) from optional ROLO-FILE or rolo-file-list. Default is to find all matching entries. Each entry is displayed with all of its sub-entries. Optional COUNT-ONLY non-nil means don't retrieve and don't display matching entries. Optional NO-DISPLAY non-nil means retrieve entries but don't display. Nil value of MAX-MATCHES means find all matches, t value means find all matches but omit file headers, negative values mean find up to the inverse of that number of entries and omit file headers. Returns number of entries matched. See also documentation for the variable rolo-file-list. Frolo-grep Display rolodex entries matching REGEXP. To a maximum of prefix arg MAX-MATCHES, in buffer(s) from optional ROLO-BUFS or rolo-file-list. Default is to find all matching entries. Each entry is displayed with all of its sub-entries. Optional COUNT-ONLY non-nil means don't retrieve and don't display matching entries. Optional NO-DISPLAY non-nil means retrieve entries but don't display. Nil value of MAX-MATCHES means find all matches, t value means find all matches but omit file headers, negative values mean find up to the inverse of that number of entries and omit file headers. Returns number of entries matched. See also documentation for the variable rolo-file-list. Frolo-kill Kills a rolodex entry given by NAME within 'rolo-file-list'. With prefix argument, prompts for optional FILE to locate entry within. NAME may be of the form: parent/child to kill child below a parent entry which begins with the parent string. Returns t if entry is killed, nil otherwise. Frolo-sort Sorts up to 14 levels of entries in ROLO-FILE (default is personal rolo). Assumes entries are delimited by one or more '*'characters. Returns list of number of groupings at each entry level. Frolo-yank Inserts at point the first rolodex entry matching NAME. With optional prefix arg, REGEXP-P, treats NAME as a regular expression instead of a string. Fmh-smail Compose and send mail with the MH mail system. This function is an entry point to mh-e, the Emacs front end to the MH mail system. See documentation of `\[mh-send]' for more details on composing mail. Fmh-smail-other-window Compose and send mail in other window with the MH mail system. This function is an entry point to mh-e, the Emacs front end to the MH mail system. See documentation of `\[mh-send]' for more details on composing mail. Fmh-letter-mode Mode for composing letters in mh-e.\<mh-letter-mode-map> When you have finished composing, type \[mh-send-letter] to send the message using the MH mail handling system. See the documentation for \[mh-edit-mhn] for information on composing MIME messages. \{mh-letter-mode-map} Variables controlling this mode (defaults in parentheses): mh-delete-yanked-msg-window (nil) If non-nil, \[mh-yank-cur-msg] will delete any windows displaying the yanked message. mh-yank-from-start-of-msg (t) If non-nil, \[mh-yank-cur-msg] will include the entire message. If `body', just yank the body (no header). If nil, only the portion of the message following the point will be yanked. If there is a region, this variable is ignored. mh-ins-buf-prefix ("> ") String to insert before each non-blank line of a message as it is inserted in a draft letter. mh-signature-file-name ("~/.signature") File to be inserted into message by \[mh-insert-signature]. Upon invoking mh-letter-mode, text-mode-hook and mh-letter-mode-hook are invoked with no args, if those values are non-nil. Fmh-rmail Inc(orporate) new mail with MH, or, with arg, scan an MH mail folder. This function is an entry point to mh-e, the Emacs front end to the MH mail system. Fmh-version Display version information about mh-e and the MH mail handling system. Vmh-mime-content-types Legal MIME content types. See documentation for \[mh-edit-mhn]. Fada-mode Ada Mode is the major mode for editing Ada code. Bindings are as follows: (Note: 'LFD' is control-j.) Indent line '\[ada-tab]' Indent line, insert newline and indent the new line. '\[newline-and-indent]' Re-format the parameter-list point is in '\[ada-format-paramlist]' Indent all lines in region '\[ada-indent-region]' Call external pretty printer program '\[ada-call-pretty-printer]' Adjust case of identifiers and keywords in region '\[ada-adjust-case-region]' Adjust case of identifiers and keywords in buffer '\[ada-adjust-case-buffer]' Call EXTERNAL pretty printer (if you have one) '\[ada-call-pretty-printer]' Fill comment paragraph '\[ada-fill-comment-paragraph]' Fill comment paragraph and justify each line '\[ada-fill-comment-paragraph-justify]' Fill comment paragraph, justify and append postfix '\[ada-fill-comment-paragraph-postfix]' Next func/proc/task '\[ada-next-procedure]' Previous func/proc/task '\[ada-previous-procedure]' Next package '\[ada-next-package]' Previous package '\[ada-previous-package]' Goto matching start of current 'end ...;' '\[ada-move-to-start]' Goto end of current block '\[ada-move-to-end]' Comments are handled using standard GNU Emacs conventions, including: Start a comment '\[indent-for-comment]' Comment region '\[comment-region]' Uncomment region '\[ada-uncomment-region]' Continue comment on next line '\[indent-new-comment-line]' If you use imenu.el: Display index-menu of functions & procedures '\[imenu]' If you use find-file.el: Switch to other file (Body <-> Spec) '\[ff-find-other-file]' or '\[ff-mouse-find-other-file] Switch to other file in other window '\[ada-ff-other-window]' or '\[ff-mouse-find-other-file-other-window] If you use this function in a spec and no body is available, it gets created with body stubs. If you use ada-xref.el: Goto declaration: '\[ada-point-and-xref]' on the identifier or '\[ada-goto-declaration]' with point on the identifier Complete identifier: '\[ada-complete-identifier]' Execute Gnatf: '\[ada-gnatf-current]' Fada-make-filename-from-adaname determine the filename of a package/procedure from its own Ada name. Fasm-mode Major mode for editing typical assembler code. Features a private abbrev table and the following bindings: \[asm-colon] outdent a preceding label, tab to next tab stop. \[tab-to-tab-stop] tab to next tab stop. \[asm-newline] newline, then tab to next tab stop. \[asm-comment] smart placement of assembler comments. The character used for making comments is set by the variable `asm-comment-char' (which defaults to `?;'). Alternatively, you may set this variable in `asm-set-comment-hook', which is called near the beginning of mode initialization. Turning on Asm mode runs the hook `asm-mode-hook' at the end of initialization. Special commands:\{asm-mode-map} Fauto-show-mode Turn automatic horizontal scroll mode on or off. With arg, turn auto scrolling on if arg is positive, off otherwise. Fawk-mode Major mode for editing AWK code. This is much like C mode except for the syntax of comments. It uses the same keymap as C mode and has the same variables for customizing indentation. It has its own abbrev table and its own syntax table. Turning on AWK mode calls the value of the variable `awk-mode-hook' with no args, if that value is non-nil. Fbibtex-mode Major mode for editing bibtex files. \{bibtex-mode-map} A command such as \[bibtex-Book] will outline the fields for a BibTeX book entry. The optional fields start with the string OPT, and thus ignored by BibTeX. The OPT string may be removed from a field with \[bibtex-remove-OPT]. \[bibtex-kill-optional-field] kills the current optional field entirely. \[bibtex-remove-double-quotes] removes the double-quotes around the text of the current field. \[bibtex-empty-field] replaces the text of the current field with the default "". The command \[bibtex-clean-entry] cleans the current entry, i.e. (i) removes double-quotes from entirely numerical fields, (ii) removes OPT from all non-empty optional fields, (iii) removes all empty optional fields, and (iv) checks that no non-optional fields are empty. Use \[bibtex-find-text] to position the dot at the end of the current field. Use \[bibtex-next-field] to move to end of the next field. The following may be of interest as well: Functions: find-bibtex-duplicates find-bibtex-entry-location hide-bibtex-entry-bodies sort-bibtex-entries validate-bibtex-buffer Variables: bibtex-clean-entry-zap-empty-opts bibtex-entry-field-alist bibtex-include-OPTannote bibtex-include-OPTcrossref bibtex-include-OPTkey bibtex-maintain-sorted-entries bibtex-mode-user-optional-fields Fields: address Publisher's address annote Long annotation used for annotated bibliographies (begins sentence) author Name(s) of author(s), in BibTeX name format booktitle Book title when the thing being referenced isn't the whole book. For book entries, the title field should be used instead. chapter Chapter number crossref The database key of the entry being cross referenced. edition Edition of a book (e.g., "second") editor Name(s) of editor(s), in BibTeX name format. If there is also an author field, then the editor field should be for the book or collection that the work appears in howpublished How something strange has been published (begins sentence) institution Sponsoring institution journal Journal name (macros are provided for many) key Alphabetizing and labeling key (needed when no author or editor) month Month (macros are provided) note To help the reader find a reference (begins sentence) number Number of a journal or technical report organization Organization (sponsoring a conference) pages Page number or numbers (use `--' to separate a range) publisher Publisher name school School name (for theses) series The name of a series or set of books. An individual book will will also have it's own title title The title of the thing being referenced type Type of a technical report (e.g., "Research Note") to be used instead of the default "Technical Report" volume Volume of a journal or multivolume work year Year---should contain only numerals --------------------------------------------------------- Entry to this mode calls the value of bibtex-mode-hook if that value is non-nil. Fc-macro-expand Expand C macros in the region, using the C preprocessor. Normally display output in temp buffer, but prefix arg means replace the region with it. `c-macro-preprocessor' specifies the preprocessor to use. Prompt for arguments to the preprocessor (e.g. `-DDEBUG -I ./include') if the user option `c-macro-prompt-flag' is non-nil. Noninteractive args are START, END, SUBST. For use inside Lisp programs, see also `c-macro-expansion'. Ff90-mode Major mode for editing Fortran 90 code in free format. \[f90-indent-new-line] corrects current indentation and creates new indented line. \[f90-indent-line] indents the current line correctly. \[f90-indent-subprogram] indents the current subprogram. Type `? or `\[help-command] to display a list of built-in abbrevs for F90 keywords. Key definitions: \{f90-mode-map} Variables controlling indentation style and extra features: f90-do-indent Extra indentation within do blocks. (default 3) f90-if-indent Extra indentation within if/select case/where/forall blocks. (default 3) f90-type-indent Extra indentation within type/interface/block-data blocks. (default 3) f90-program-indent Extra indentation within program/module/subroutine/function blocks. (default 2) f90-continuation-indent Extra indentation applied to continuation lines. (default 5) f90-comment-region String inserted by \[f90-comment-region] at start of each line in region. (default "!!!$") f90-indented-comment String holding the type of comment to be intended like code. This is a regular expression. (default "!") f90-directive-comment String of comment-like directive like "!HPF$", not to be indented. (default nil) f90-break-delimiters Regexp holding list of delimiters at which lines may be broken. (default "[-+*/><=,% \t]") f90-break-before-delimiters Non-nil causes `f90-do-auto-fill' to break lines before delimiters. (default t) f90-beginning-ampersand Automatic insertion of & at beginning of continuation lines. (default t) f90-smart-end From an END statement, check and fill the end using matching block start. Allowed values are 'blink, 'no-blink, and nil, which determine whether to blink the matching beginning.) (default 'blink) f90-auto-keyword-case Automatic change of case of keywords. (default nil) The possibilities are 'downcase-word, 'upcase-word, 'capitalize-word. f90-auto-hilit19 (default nil) Automatic highlighting (if hilit19 is used) at every indent or newline. f90-leave-line-no Do not left-justify line numbers. (default nil) f90-startup-message Set to nil to inhibit message first time F90 mode is used. (default t) f90-keywords List of keywords used for highlighting/upcase-keywords etc. Turning on F90 mode calls the value of the variable `f90-mode-hook' with no args, if that value is non-nil. Vfortran-tab-mode-default *Default tabbing/carriage control style for empty files in Fortran mode. A value of t specifies tab-digit style of continuation control. A value of nil specifies that continuation lines are marked with a character in column 6. Ffortran-mode Major mode for editing Fortran code. \[fortran-indent-line] indents the current Fortran line correctly. DO statements must not share a common CONTINUE. Type ;? or ;\[help-command] to display a list of built-in abbrevs for Fortran keywords. Key definitions: \{fortran-mode-map} Variables controlling indentation style and extra features: comment-start Normally nil in Fortran mode. If you want to use comments starting with `!', set this to the string "!". fortran-do-indent Extra indentation within do blocks. (default 3) fortran-if-indent Extra indentation within if blocks. (default 3) fortran-structure-indent Extra indentation within structure, union, map and interface blocks. (default 3) fortran-continuation-indent Extra indentation applied to continuation statements. (default 5) fortran-comment-line-extra-indent Amount of extra indentation for text within full-line comments. (default 0) fortran-comment-indent-style nil means don't change indentation of text in full-line comments, fixed means indent that text at `fortran-comment-line-extra-indent' beyond the value of `fortran-minimum-statement-indent-fixed' (for fixed format continuation style) or `fortran-minimum-statement-indent-tab' (for TAB format continuation style). relative means indent at `fortran-comment-line-extra-indent' beyond the indentation for a line of code. (default 'fixed) fortran-comment-indent-char Single-character string to be inserted instead of space for full-line comment indentation. (default " ") fortran-minimum-statement-indent-fixed Minimum indentation for Fortran statements in fixed format mode. (def.6) fortran-minimum-statement-indent-tab Minimum indentation for Fortran statements in TAB format mode. (default 9) fortran-line-number-indent Maximum indentation for line numbers. A line number will get less than this much indentation if necessary to avoid reaching column 5. (default 1) fortran-check-all-num-for-matching-do Non-nil causes all numbered lines to be treated as possible "continue" statements. (default nil) fortran-blink-matching-if From a Fortran ENDIF statement, blink the matching IF statement. Also, from an ENDDO statement, blink on matching DO [WHILE] statement. (default nil) fortran-continuation-string Single-character string to be inserted in column 5 of a continuation line. (default "$") fortran-comment-region String inserted by \[fortran-comment-region] at start of each line in region. (default "c$$$") fortran-electric-line-number Non-nil causes line number digits to be moved to the correct column as typed. (default t) fortran-break-before-delimiters Non-nil causes `fortran-do-auto-fill' breaks lines before delimiters. (default t) fortran-startup-message Set to nil to inhibit message first time Fortran mode is used. Turning on Fortran mode calls the value of the variable `fortran-mode-hook' with no args, if that value is non-nil. Fhs-hide-all Hides all top-level blocks, displaying only first and last lines. When done, point is repositioned at the beginning of the line, and hs-hide-hooks is called. See documentation for `run-hooks'. Fhs-hide-block Selects a block and hides it. With prefix arg, reposition at end. Block is defined as a sexp for lispish modes, mode-specific otherwise. Comments are blocks, too. Upon completion, point is at repositioned and hs-hide-hooks is called. See documentation for `run-hooks'. Fhs-minor-mode Toggle hideshow minor mode. With ARG, turn hideshow minor mode on if ARG is positive, off otherwise. When hideshow minor mode is on, the menu bar is augmented with hideshow commands and the hideshow commands are enabled. The variables selective-display selective-display-ellipses are set to t. Lastly, the hooks set in hs-minor-mode-hook are called. See documentation for `run-hooks'. Turning hideshow minor mode off reverts the menu bar and the variables to default values and disables the hideshow commands. Fksh-mode ksh-mode 2.6 - Major mode for editing (Bourne, Korn or Bourne again) shell scripts. Special key bindings and commands: \{ksh-mode-map} Variables controlling indentation style: ksh-indent Indentation of ksh statements with respect to containing block. Default value is 2. ksh-case-indent Additional indentation for statements under case items. Default value is nil which will align the statements one position past the ")" of the pattern. ksh-case-item-offset Additional indentation for case items within a case statement. Default value is 2. ksh-group-offset Additional indentation for keywords "do" and "then". Default value is -2. ksh-brace-offset Additional indentation of "{" under functions or brace groupings. Default value is 0. ksh-multiline-offset Additional indentation of line that is preceded of a line ending with a \ to make it continue on next line. ksh-tab-always-indent Controls the operation of the TAB key. If t (the default), always reindent the current line. If nil, indent the current line only if point is at the left margin or in the line's indentation; otherwise insert a tab. ksh-match-and-tell If non-nil echo in the minibuffer the matching compound command for the "done", "}", "fi", or "esac". Default value is t. ksh-align-to-keyword Controls whether nested constructs align from the keyword or the current indentation. If non-nil, indentation will be relative to the column the keyword starts. If nil, indentation will be relative to the current indentation of the line the keyword is on. The default value is non-nil. ksh-comment-regexp Regular expression used to recognize comments. Customize to support ksh-like languages. Default value is "\s *#". Style Guide. By setting (setq ksh-indent default-tab-width) (setq ksh-group-offset 0) The following style is obtained: if [ -z $foo ] then bar # <-- ksh-group-offset is additive to ksh-indent foo fi By setting (setq ksh-indent default-tab-width) (setq ksh-group-offset (- 0 ksh-indent)) The following style is obtained: if [ -z $foo ] then bar foo fi By setting (setq ksh-case-item-offset 1) (setq ksh-case-indent nil) The following style is obtained: case x in * foo) bar # <-- ksh-case-item-offset baz;; # <-- ksh-case-indent aligns with ")" foobar) foo bar;; esac By setting (setq ksh-case-item-offset 1) (setq ksh-case-indent 6) The following style is obtained: case x in * foo) bar # <-- ksh-case-item-offset baz;; # <-- ksh-case-indent foobar) foo bar;; esac Installation: Put ksh-mode.el in some directory in your load-path. Put the following forms in your .emacs file. (setq auto-mode-alist (append auto-mode-alist (list '("\\.sh$" . ksh-mode) '("\\.ksh$" . ksh-mode) '("\\.bashrc" . ksh-mode) '("\\..*profile" . ksh-mode)))) (setq ksh-mode-hook (function (lambda () (font-lock-mode 1) ;; font-lock the buffer (setq ksh-indent 8) (setq ksh-group-offset -8)) (setq ksh-brace-offset -8) (setq ksh-tab-always-indent t) (setq ksh-match-and-tell t) (setq ksh-align-to-keyword t) ;; Turn on keyword alignment ))) Frexx-mode Major mode for editing REXX code. \{rexx-mode-map} Variables controlling indentation style: rexx-indent The basic indentation for do-blocks. rexx-end-indent The relative offset of the "end" statement. 0 places it in the same column as the statements of the block. Setting it to the same value as rexx-indent places the "end" under the do-line. rexx-cont-indent The indention for lines following "then", "else" and "," (continued) lines. rexx-tab-always-indent Non-nil means TAB in REXX mode should always reindent the current line, regardless of where in the line the point is when the TAB command is used. If you have set rexx-end-indent to a nonzero value, you probably want to remap RETURN to rexx-indent-newline-indent. It makes sure that lines indents correctly when you press RETURN. An extensive abbrevation table consisting of all the keywords of REXX are supplied. Expanded keywords are converted into upper case making it easier to distinguish them. To use this feature the buffer must be in abbrev-mode. (See example below.) Turning on REXX mode calls the value of the variable rexx-mode-hook with no args, if that value is non-nil. For example: (setq rexx-mode-hook '(lambda () (setq rexx-indent 4) (setq rexx-end-indent 4) (setq rexx-cont-indent 4) (local-set-key "\C-m" 'rexx-indent-newline-indent) (abbrev-mode 1) )) will make the END aligned with the DO/SELECT. It will indent blocks and IF-statenents four steps and make sure that the END jumps into the correct position when RETURN is pressed. Finaly it will use the abbrev table to convert all REXX keywords into upper case. Vmail-abbrev-mailrc-file Name of file with mail aliases. If nil, ~/.mailrc is used. Vmail-aliases Word-abbrev table of mail address aliases. If this is nil, it means the aliases have not yet been initialized and should be read from the .mailrc file. (This is distinct from there being no aliases, which is represented by this being a table with no entries.) Fbuild-mail-aliases Read mail aliases from .mailrc and set mail-aliases. Fdefine-mail-alias Define NAME as a mail-alias that translates to DEFINITION. If DEFINITION contains multiple addresses, separate them with commas. Fmakefile-mode Major mode for editing Makefiles. Calling this function invokes the function(s) "makefile-mode-hook" before doing anything else. \{makefile-mode-map} In the browser, use the following keys: \{makefile-browser-map} makefile-mode can be configured by modifying the following variables: makefile-mode-name: The "pretty name" of makefile-mode, as it appears in the modeline. makefile-browser-buffer-name: Name of the macro- and target browser buffer. makefile-target-colon: The string that gets appended to all target names inserted by makefile-insert-target. ":" or "::" are quite common values. makefile-macro-assign: The string that gets appended to all macro names inserted by makefile-insert-macro. The normal value should be " = ", since this is what standard make expects. However, newer makes such as dmake allow a larger variety of different macro assignments, so you might prefer to use " += " or " := " . makefile-tab-after-target-colon: If you want a TAB (instead of a space) to be appended after the target colon, then set this to a non-nil value. makefile-browser-leftmost-column: Number of blanks to the left of the browser selection mark. makefile-browser-cursor-column: Column in which the cursor is positioned when it moves up or down in the browser. makefile-browser-selected-mark: String used to mark selected entries in the browser. makefile-browser-unselected-mark: String used to mark unselected entries in the browser. makefile-browser-auto-advance-after-selection-p: If this variable is set to a non-nil value the cursor will automagically advance to the next line after an item has been selected in the browser. makefile-pickup-everything-picks-up-filenames-p: If this variable is set to a non-nil value then makefile-pickup-everything also picks up filenames as targets (i.e. it calls makefile-find-filenames-as-targets), otherwise filenames are omitted. makefile-cleanup-continuations-p: If this variable is set to a non-nil value then makefile-mode will assure that no line in the file ends with a backslash (the continuation character) followed by any whitespace. This is done by silently removing the trailing whitespace, leaving the backslash itself intact. IMPORTANT: Please note that enabling this option causes makefile-mode to MODIFY A FILE WITHOUT YOUR CONFIRMATION when 'it seems necessary'. makefile-browser-hook: A function or list of functions to be called just before the browser is entered. This is executed in the makefile buffer. makefile-special-targets-list: List of special targets. You will be offered to complete on one of those in the minibuffer whenever you enter a "." at the beginning of a line in makefile-mode. Fmodula-2-mode This is a mode intended to support program development in Modula-2. All control constructs of Modula-2 can be reached by typing Control-C followed by the first character of the construct. \{m2-mode-map} Control-c b begin Control-c c case Control-c d definition Control-c e else Control-c f for Control-c h header Control-c i if Control-c m module Control-c l loop Control-c o or Control-c p procedure Control-c Control-w with Control-c r record Control-c s stdio Control-c t type Control-c u until Control-c v var Control-c w while Control-c x export Control-c y import Control-c { begin-comment Control-c } end-comment Control-c Control-z suspend-emacs Control-c Control-t toggle Control-c Control-c compile Control-x ` next-error Control-c Control-l link m2-indent controls the number of spaces for each indentation. m2-compile-command holds the command to compile a Modula-2 program. m2-link-command holds the command to link a Modula-2 program. Fnroff-mode Major mode for editing text intended for nroff to format. \{nroff-mode-map} Turning on Nroff mode runs `text-mode-hook', then `nroff-mode-hook'. Also, try `nroff-electric-mode', for automatically inserting closing requests for requests that are used in matched pairs. Foutl-mouse-mode Calls outline-mode, with outl-mouse extensions Foutl-mouse-minor-mode Toggles outline-minor-mode, with outl-mouse extensions Foutline-mode Set major mode for editing outlines with selective display. Headings are lines which start with asterisks: one for major headings, two for subheadings, etc. Lines not starting with asterisks are body lines. Body text or subheadings under a heading can be made temporarily invisible, or visible again. Invisible lines are attached to the end of the heading, so they move with it, if the line is killed and yanked back. A heading with text hidden under it is marked with an ellipsis (...). Commands:\<outline-mode-map> \[outline-next-visible-heading] outline-next-visible-heading move by visible headings \[outline-previous-visible-heading] outline-previous-visible-heading \[outline-forward-same-level] outline-forward-same-level similar but skip subheadings \[outline-backward-same-level] outline-backward-same-level \[outline-up-heading] outline-up-heading move from subheading to heading \[hide-body] make all text invisible (not headings). \[show-all] make everything in buffer visible. The remaining commands are used when point is on a heading line. They apply to some of the body or subheadings of that heading. \[hide-subtree] hide-subtree make body and subheadings invisible. \[show-subtree] show-subtree make body and subheadings visible. \[show-children] show-children make direct subheadings visible. No effect on body, or subheadings 2 or more levels down. With arg N, affects subheadings N levels down. \[hide-entry] make immediately following body invisible. \[show-entry] make it visible. \[hide-leaves] make body under heading and under its subheadings invisible. The subheadings remain visible. \[show-branches] make all subheadings at all levels visible. The variable `outline-regexp' can be changed to control what is a heading. A line is a heading if `outline-regexp' matches something at the beginning of the line. The longer the match, the deeper the level. Turning on outline mode calls the value of `text-mode-hook' and then of `outline-mode-hook', if they are non-nil. Foutline-minor-mode Toggle Outline minor mode. With arg, turn Outline minor mode on if arg is positive, off otherwise. See the command `outline-mode' for more information on this mode. Fpascal-mode Major mode for editing Pascal code. \<pascal-mode-map> TAB indents for Pascal code. Delete converts tabs to spaces as it moves back. \[pascal-complete-word] completes the word around current point with respect to position in code \[pascal-show-completions] shows all possible completions at this point. Other useful functions are: \[pascal-mark-defun] - Mark function. \[pascal-insert-block] - insert begin ... end; \[pascal-star-comment] - insert (* ... *) \[pascal-comment-area] - Put marked area in a comment, fixing nested comments. \[pascal-uncomment-area] - Uncomment an area commented with \[pascal-comment-area]. \[pascal-beg-of-defun] - Move to beginning of current function. \[pascal-end-of-defun] - Move to end of current function. \[pascal-goto-defun] - Goto function prompted for in the minibuffer. \[pascal-outline] - Enter pascal-outline-mode (see also pascal-outline). Variables controlling indentation/edit style: pascal-indent-level (default 3) Indentation of Pascal statements with respect to containing block. pascal-case-indent (default 2) Indentation for case statements. pascal-auto-newline (default nil) Non-nil means automatically newline after simcolons and the punctation mark after an end. pascal-tab-always-indent (default t) Non-nil means TAB in Pascal mode should always reindent the current line, regardless of where in the line point is when the TAB command is used. pascal-auto-endcomments (default t) Non-nil means a comment { ... } is set after the ends which ends cases and functions. The name of the function or case will be set between the braces. pascal-auto-lineup (default t) List of contexts where auto lineup of :'s or ='s hould be done. See also the user variables pascal-type-keywords, pascal-start-keywords and pascal-separator-keywords. Turning on Pascal mode calls the value of the variable pascal-mode-hook with no args, if that value is non-nil. Fperl-mode Major mode for editing Perl code. Expression and list commands understand all Perl brackets. Tab indents for Perl code. Comments are delimited with # ... \n. Paragraphs are separated by blank lines only. Delete converts tabs to spaces as it moves back. \{perl-mode-map} Variables controlling indentation style: perl-tab-always-indent Non-nil means TAB in Perl mode should always indent the current line, regardless of where in the line point is when the TAB command is used. perl-tab-to-comment Non-nil means that for lines which don't need indenting, TAB will either delete an empty comment, indent an existing comment, move to end-of-line, or if at end-of-line already, create a new comment. perl-nochange Lines starting with this regular expression will not be auto-indented. perl-indent-level Indentation of Perl statements within surrounding block. The surrounding block's indentation is the indentation of the line on which the open-brace appears. perl-continued-statement-offset Extra indentation given to a substatement, such as the then-clause of an if or body of a while. perl-continued-brace-offset Extra indentation given to a brace that starts a substatement. This is in addition to perl-continued-statement-offset. perl-brace-offset Extra indentation for line if it starts with an open brace. perl-brace-imaginary-offset An open brace following other text is treated as if it were this far to the right of the start of its line. perl-label-offset Extra indentation for line that is a label. Various indentation styles: K&R BSD BLK GNU LW perl-indent-level 5 8 0 2 4 perl-continued-statement-offset 5 8 4 2 4 perl-continued-brace-offset 0 0 0 0 -4 perl-brace-offset -5 -8 0 0 0 perl-brace-imaginary-offset 0 0 4 0 0 perl-label-offset -5 -8 -2 -2 -2 Turning on Perl mode calls the value of the variable perl-mode-hook with no args, if that value is non-nil. Fpicture-mode Switch to Picture mode, in which a quarter-plane screen model is used. Printing characters replace instead of inserting themselves with motion afterwards settable by these commands: C-c < Move left after insertion. C-c > Move right after insertion. C-c ^ Move up after insertion. C-c . Move down after insertion. C-c ` Move northwest (nw) after insertion. C-c ' Move northeast (ne) after insertion. C-c / Move southwest (sw) after insertion. C-c \ Move southeast (se) after insertion. The current direction is displayed in the modeline. The initial direction is right. Whitespace is inserted and tabs are changed to spaces when required by movement. You can move around in the buffer with these commands: \[picture-move-down] Move vertically to SAME column in previous line. \[picture-move-up] Move vertically to SAME column in next line. \[picture-end-of-line] Move to column following last non-whitespace character. \[picture-forward-column] Move right inserting spaces if required. \[picture-backward-column] Move left changing tabs to spaces if required. C-c C-f Move in direction of current picture motion. C-c C-b Move in opposite direction of current picture motion. Return Move to beginning of next line. You can edit tabular text with these commands: M-Tab Move to column beneath (or at) next interesting character. `Indents' relative to a previous line. Tab Move to next stop in tab stop list. C-c Tab Set tab stops according to context of this line. With ARG resets tab stops to default (global) value. See also documentation of variable picture-tab-chars which defines "interesting character". You can manually change the tab stop list with command \[edit-tab-stops]. You can manipulate text with these commands: C-d Clear (replace) ARG columns after point without moving. C-c C-d Delete char at point - the command normally assigned to C-d. \[picture-backward-clear-column] Clear (replace) ARG columns before point, moving back over them. \[picture-clear-line] Clear ARG lines, advancing over them. The cleared text is saved in the kill ring. \[picture-open-line] Open blank line(s) beneath current line. You can manipulate rectangles with these commands: C-c C-k Clear (or kill) a rectangle and save it. C-c C-w Like C-c C-k except rectangle is saved in named register. C-c C-y Overlay (or insert) currently saved rectangle at point. C-c C-x Like C-c C-y except rectangle is taken from named register. \[copy-rectangle-to-register] Copies a rectangle to a register. \[advertised-undo] Can undo effects of rectangle overlay commands commands if invoked soon enough. You can return to the previous mode with: C-c C-c Which also strips trailing whitespace from every line. Stripping is suppressed by supplying an argument. Entry to this mode calls the value of picture-mode-hook if non-nil. Note that Picture mode commands will work outside of Picture mode, but they are not defaultly assigned to keys. Fpostscript-mode Major mode for editing PostScript files. \[ps-execute-buffer] will send the contents of the buffer to the NeWS server using psh(1). \[ps-execute-region] sends the current region. \[ps-shell] starts an interactive psh(1) window which will be used for subsequent \[ps-execute-buffer] or \[ps-execute-region] commands. In this mode, TAB and \[indent-region] attempt to indent code based on the position of {}, [], and begin/end pairs. The variable ps-indent-level controls the amount of indentation used inside arrays and begin/end pairs. \{ps-mode-map} \[postscript-mode] calls the value of the variable postscript-mode-hook with no args, if that value is non-nil. Fprolog-mode Major mode for editing Prolog code for Prologs. Blank lines and `%%...' separate paragraphs. `%'s start comments. Commands: \{prolog-mode-map} Entry to this mode calls the value of prolog-mode-hook if that value is non-nil. Finferior-prolog-mode Major mode for interacting with an inferior Prolog process. The following commands are available: \{inferior-prolog-mode-map} Entry to this mode calls the value of prolog-mode-hook with no arguments, if that value is non-nil. Likewise with the value of comint-mode-hook. prolog-mode-hook is called after comint-mode-hook. You can send text to the inferior Prolog from other buffers using the commands send-region, send-string and \[prolog-consult-region]. Commands: Tab indents for Prolog; with argument, shifts rest of expression rigidly with the current line. Paragraphs are separated only by blank lines and '%%'. '%'s start comments. Return at end of buffer sends line as input. Return not at end copies rest of line to end and sends it. \[comint-kill-input] and \[backward-kill-word] are kill commands, imitating normal Unix input editing. \[comint-interrupt-subjob] interrupts the shell or its current subjob if any. \[comint-stop-subjob] stops. \[comint-quit-subjob] sends quit signal. Frun-prolog Run an inferior Prolog process, input and output via buffer *prolog*. Vresize-minibuffer-mode *If non-`nil', resize the minibuffer so its entire contents are visible. Vresize-minibuffer-window-max-height *Maximum size the minibuffer window is allowed to become. If less than 1 or not a number, the limit is the height of the frame in which the active minibuffer window resides. Vresize-minibuffer-window-exactly *If non-`nil', make minibuffer exactly the size needed to display all its contents. Otherwise, the minibuffer window can temporarily increase in size but never get smaller while it is active. Vresize-minibuffer-frame *If non-`nil' and the active minibuffer is the sole window in its frame, allow changing the frame height. Vresize-minibuffer-frame-max-height *Maximum size the minibuffer frame is allowed to become. If less than 1 or not a number, there is no limit. Vresize-minibuffer-frame-exactly *If non-`nil', make minibuffer frame exactly the size needed to display all its contents. Otherwise, the minibuffer frame can temporarily increase in size but never get smaller while it is active. Fresize-minibuffer-mode Enable or disable resize-minibuffer mode. A negative prefix argument disables this mode. A positive argument or argument of 0 enables it. When this minor mode is enabled, the minibuffer is dynamically resized to contain the entire region of text put in it as you type. The variable `resize-minibuffer-mode' is set to t or nil depending on whether this mode is active or not. The maximum height to which the minibuffer can grow is controlled by the variable `resize-minibuffer-window-max-height'. The variable `resize-minibuffer-window-exactly' determines whether the minibuffer window should ever be shrunk to make it no larger than needed to display its contents. When using a window system, it is possible for a minibuffer to tbe the sole window in a frame. Since that window is already its maximum size, the only way to make more text visible at once is to increase the size of the frame. The variable `resize-minibuffer-frame' controls whether this should be done. The variables `resize-minibuffer-frame-max-height' and `resize-minibuffer-frame-exactly' are analogous to their window counterparts. Fscheme-mode Major mode for editing Scheme code. Editing commands are similar to those of lisp-mode. In addition, if an inferior Scheme process is running, some additional commands will be defined, for evaluating expressions and controlling the interpreter, and the state of the process will be displayed in the modeline of all Scheme buffers. The names of commands that interact with the Scheme process start with "xscheme-". For more information see the documentation for xscheme-interaction-mode. Commands: Delete converts tabs to spaces as it moves back. Blank lines separate paragraphs. Semicolons start comments. \{scheme-mode-map} Entry to this mode calls the value of scheme-mode-hook if that value is non-nil. Fscribe-mode Major mode for editing files of Scribe (a text formatter) source. Scribe-mode is similar text-mode, with a few extra commands added. \{scribe-mode-map} Interesting variables: scribe-fancy-paragraphs Non-nil makes Scribe mode use a different style of paragraph separation. scribe-electric-quote Non-nil makes insert of double quote use `` or '' depending on context. scribe-electric-parenthesis Non-nil makes an open-parenthesis char (one of `([<{') automatically insert its close if typed after an @Command form. Vmail-self-blind Non-nil means insert BCC to self in messages to be sent. This is done when the message is initialized, so you can remove or alter the BCC field to override the default. Vmail-interactive Non-nil means when sending a message wait for and display errors. nil means let mailer mail back a message to report errors. Vmail-dir *Default directory for saving messages. Vrmail-ignored-headers *Gubbish header fields one would rather not see. Vmail-yank-ignored-headers Delete these headers from old message when it's inserted in a reply. Vsend-mail-function Function to call to send the current buffer as mail. The headers are be delimited by a line which is `mail-header-separator'. Vmail-header-separator *Line used to separate headers from text in messages being composed. Vmail-archive-file-name *Name of file to write all outgoing messages in, or nil for none. Do not use an rmail file here! Instead, use its inbox file. Vmail-yank-prefix *Prefix insert on lines of yanked message being replied to. nil means use indentation. Vmail-signature *Text inserted at end of mail buffer when a message is initialized. If t, it means to insert the contents of the file `mail-signature-file'. Fmail-mode Major mode for editing mail to be sent. Like Text Mode but with these additional commands: C-c C-s mail-send (send the message) C-c C-c mail-send-and-exit C-c C-f move to a header field (and create it if there isn't): C-c C-f C-t move to To: C-c C-f C-s move to Subj: C-c C-f C-b move to BCC: C-c C-f C-c move to CC: C-c C-f C-r move to Reply-To: C-c C-t move to message text. C-c C-y mail-yank-original (insert current message, in Rmail). C-c C-w mail-signature (insert signature file). C-c C-q mail-fill-yanked-message (fill what was yanked). C-c C-v mail-sent-via (add a sent-via field for each To or CC) Button3 Popup menu with the above commands. Fmail Edit a message to be sent. Prefix arg means resume editing (don't erase). When this function returns, the buffer `*mail*' is selected. The value is t if the message was newly initialized; otherwise, nil. \<mail-mode-map> While editing message, type \[mail-send-and-exit] to send the message and exit. Various special commands starting with C-c are available in sendmail mode to move to message header fields: \{mail-mode-map} The variable `mail-signature' controls whether the signature file `mail-signature-file' is inserted immediately. If `mail-insert-signature' is non-nil, the signature file, denoted by the variable `mail-signature-file', is automatically inserted at the end of the message before sending. (Otherwise use C-c C-w). If `mail-self-blind' is non-nil, a BCC to yourself is inserted when the message is initialized. If `mail-default-reply-to' is non-nil, it should be an address (a string); a Reply-to: field with that address is inserted. If `mail-archive-file-name' is non-nil, an FCC field with that file name is inserted. If `mail-setup-hook' is bound, its value is called with no arguments after the message is initialized. It can add more default fields. When calling from a program, the second through fifth arguments TO, SUBJECT, IN-REPLY-TO and CC specify if non-nil the initial contents of those header fields. These arguments should not have final newlines. The sixth argument REPLYBUFFER is a buffer whose contents should be yanked if the user types C-c C-y. The seventh argument ACTIONS is a list of actions to take if/when the message is sent. Each action looks like (FUNCTION . ARGS); when the message is sent, we apply FUNCTION to ARGS. This is how Rmail arranges to mark messages `answered'. Fmail-other-window Like `mail' command, but display mail buffer in another window. Fmail-other-frame Like `mail' command, but display mail buffer in another frame. Fsgml-mode Major mode for editing SGML. Makes > display the matching <. Makes / display matching /. Use \[sgml-validate] to validate your document with an SGML parser. Ftcl-mode Major mode for editing Tcl code. Expression and list commands understand all Tcl brackets. Tab indents for Tcl code. Paragraphs are separated by blank lines only. Delete converts tabs to spaces as it moves back. Variables controlling indentation style: tcl-indent-level Indentation of Tcl statements within surrounding block. tcl-continued-indent-level Indentation of continuation line relative to first line of command. Variables controlling user interaction with mode (see variable documentation for details): tcl-tab-always-indent Controls action of TAB key. tcl-auto-newline Non-nil means automatically newline before and after braces, brackets, and semicolons inserted in Tcl code. tcl-electric-hash-style Controls action of `#' key. tcl-use-hairy-comment-detector If t, use more complicated, but slower, comment detector. This variable is only used in GNU Emacs 19. Turning on Tcl mode calls the value of the variable `tcl-mode-hook' with no args, if that value is non-nil. Read the documentation for `tcl-mode-hook' to see what kinds of interesting hook functions already exist. Commands: \{tcl-mode-map} Finferior-tcl Run inferior Tcl process. Prefix arg means enter program name interactively. See documentation for function `inferior-tcl-mode' for more information. Ftcl-help-on-word Get help on Tcl command. Default is word at point. Prefix argument means invert sense of `tcl-use-smart-word-finder'. Ftex-mode Major mode for editing files of input for TeX, LaTeX, or SliTeX. Tries to determine (by looking at the beginning of the file) whether this file is for plain TeX, LaTeX, or SliTeX and calls plain-tex-mode, latex-mode, or slitex-mode, respectively. If it cannot be determined, such as if there are no commands in the file, the value of tex-default-mode is used. Fplain-tex-mode Major mode for editing files of input for plain TeX. Makes $ and } display the characters they match. Makes " insert `` when it seems to be the beginning of a quotation, and '' when it appears to be the end; it inserts " only after a \. Use \[tex-region] to run TeX on the current region, plus a "header" copied from the top of the file (containing macro definitions, etc.), running TeX under a special subshell. \[tex-buffer] does the whole buffer. \[tex-file] saves the buffer and then processes the file. \[tex-print] prints the .dvi file made by any of these. \[tex-view] previews the .dvi file made by any of these. \[tex-bibtex-file] runs bibtex on the file of the current buffer. Use \[validate-tex-buffer] to check buffer for paragraphs containing mismatched $'s or braces. Special commands: \{tex-mode-map} Mode variables: tex-run-command Command string used by \[tex-region] or \[tex-buffer]. tex-directory Directory in which to create temporary files for TeX jobs run by \[tex-region] or \[tex-buffer]. tex-dvi-print-command Command string used by \[tex-print] to print a .dvi file. tex-alt-dvi-print-command Alternative command string used by \[tex-print] (when given a prefix argument) to print a .dvi file. tex-dvi-view-command Command string used by \[tex-view] to preview a .dvi file. tex-show-queue-command Command string used by \[tex-show-print-queue] to show the print queue that \[tex-print] put your job on. Entering Plain-tex mode calls the value of text-mode-hook, then the value of tex-mode-hook, and then the value of plain-tex-mode-hook. When the special subshell is initiated, the value of tex-shell-hook is called. Flatex-mode Major mode for editing files of input for LaTeX. Makes $ and } display the characters they match. Makes " insert `` when it seems to be the beginning of a quotation, and '' when it appears to be the end; it inserts " only after a \. Use \[tex-region] to run LaTeX on the current region, plus the preamble copied from the top of the file (containing \documentstyle, etc.), running LaTeX under a special subshell. \[tex-buffer] does the whole buffer. \[tex-file] saves the buffer and then processes the file. \[tex-print] prints the .dvi file made by any of these. \[tex-view] previews the .dvi file made by any of these. \[tex-bibtex-file] runs bibtex on the file of the current buffer. Use \[validate-tex-buffer] to check buffer for paragraphs containing mismatched $'s or braces. Special commands: \{tex-mode-map} Mode variables: latex-run-command Command string used by \[tex-region] or \[tex-buffer]. tex-directory Directory in which to create temporary files for LaTeX jobs run by \[tex-region] or \[tex-buffer]. tex-dvi-print-command Command string used by \[tex-print] to print a .dvi file. tex-alt-dvi-print-command Alternative command string used by \[tex-print] (when given a prefix argument) to print a .dvi file. tex-dvi-view-command Command string used by \[tex-view] to preview a .dvi file. tex-show-queue-command Command string used by \[tex-show-print-queue] to show the print queue that \[tex-print] put your job on. Entering Latex mode calls the value of text-mode-hook, then the value of tex-mode-hook, and then the value of latex-mode-hook. When the special subshell is initiated, the value of tex-shell-hook is called. Ftexinfo-mode Major mode for editing Texinfo files. It has these extra commands: \{texinfo-mode-map} These are files that are used as input for TeX to make printed manuals and also to be turned into Info files with \[makeinfo-buffer] or the `makeinfo' program. These files must be written in a very restricted and modified version of TeX input format. Editing commands are like text-mode except that the syntax table is set up so expression commands skip Texinfo bracket groups. To see what the Info version of a region of the Texinfo file will look like, use \[makeinfo-region], which runs `makeinfo' on the current region. You can show the structure of a Texinfo file with \[texinfo-show-structure]. This command shows the structure of a Texinfo file by listing the lines with the @-sign commands for @chapter, @section, and the like. These lines are displayed in another window called the *Occur* window. In that window, you can position the cursor over one of the lines and use \[occur-mode-goto-occurrence], to jump to the corresponding spot in the Texinfo file. In addition, Texinfo mode provides commands that insert various frequently used @-sign commands into the buffer. You can use these commands to save keystrokes. And you can insert balanced braces with \[texinfo-insert-braces] and later use the command \[up-list] to move forward past the closing brace. Also, Texinfo mode provides functions for automatically creating or updating menus and node pointers. These functions * insert the `Next', `Previous' and `Up' pointers of a node, * insert or update the menu for a section, and * create a master menu for a Texinfo source file. Here are the functions: texinfo-update-node \[texinfo-update-node] texinfo-every-node-update \[texinfo-every-node-update] texinfo-sequential-node-update texinfo-make-menu \[texinfo-make-menu] texinfo-all-menus-update \[texinfo-all-menus-update] texinfo-master-menu texinfo-indent-menu-description (column &optional region-p) The `texinfo-column-for-description' variable specifies the column to which menu descriptions are indented. Passed an argument (a prefix argument, if interactive), the `texinfo-update-node' and `texinfo-make-menu' functions do their jobs in the region. To use the updating commands, you must structure your Texinfo file hierarchically, such that each `@node' line, with the exception of the Top node, is accompanied by some kind of section line, such as an `@chapter' or `@section' line. If the file has a `top' node, it must be called `top' or `Top' and be the first node in the file. Entering Texinfo mode calls the value of text-mode-hook, and then the value of texinfo-mode-hook. Vtc-mode-map Keymap for commands for two-column mode. Ftc-two-columns Split current window vertically for two-column editing. When called the first time, associates a buffer with the current buffer. Both buffers are put in two-column minor mode and tc-mode-hook gets called on both. These buffers remember about one another, even when renamed. When called again, restores the screen layout with the current buffer first and the associated buffer to it's right. If you include long lines, i.e which will span both columns (eg. source code), they should be in what will be the first column, with the associated buffer having empty lines next to them. You have the following commands at your disposal: \[tc-two-columns] Rearrange screen \[tc-associate-buffer] Reassociate buffer after changing major mode \[tc-scroll-up] Scroll both buffers up by a screenfull \[tc-scroll-down] Scroll both buffers down by a screenful \[tc-scroll-line] Scroll both buffers up by one or more lines \[tc-recenter] Recenter and realign other buffer \[shrink-window-horizontally], \[enlarge-window-horizontally] Shrink, enlarge current column \[tc-associated-buffer] Switch to associated buffer \[tc-merge] Merge both buffers These keybindings can be customized in your ~/.emacs by `tc-prefix' and `tc-mode-map'. The appearance of the screen can be customized by the variables `tc-window-width', `tc-beyond-fill-column', `tc-mode-line-format' and `truncate-partial-width-windows'. Ftc-associate-buffer Associate another buffer with this one in two-column minor mode. Can also be used to associate a just previously visited file, by accepting the proposed default buffer. See \[tc-two-columns] and `lisp/two-column.el' for further details. Ftc-split Unmerge a two-column text into two buffers in two-column minor mode. The text is unmerged at the cursor's column which becomes the local value of `tc-window-width'. Only lines that have the ARG same preceding characters at that column get split. The ARG preceding characters without any leading whitespace become the local value for `tc-separator'. This way lines that continue across both columns remain untouched in the first buffer. This function can be used with a prototype line, to set up things as you like them. You write the first line of each column with the separator you like and then unmerge that line. E.g.: First column's text sSs Second columns text \___/\ / \ 5 character Separator You type M-5 \[tc-split] with the point here See \[tc-two-columns] and `lisp/two-column.el' for further details. Ftc-dissociate Turn off two-column minor mode in current and associated buffer. If the associated buffer is unmodified and empty, it is killed. Ftc-merge Merges the associated buffer with the current buffer. They get merged at the column, which is the value of `tc-window-width', i.e. usually at the vertical window separator. This separator gets replaced with white space. Beyond that the value of gets inserted on merged lines. The two columns are thus pasted side by side, in a single text. If the other buffer is not displayed to the left of this one, then this one becomes the left column. If you want `tc-separator' on empty lines in the second column, you should put just one space in them. In the final result, you can strip off trailing spaces with \[beginning-of-buffer] \[replace-regexp] [ SPC TAB ] + $ RET RET Ftc-associated-buffer Switch to associated buffer. Ftc-scroll-line Scroll current window upward by ARG lines. The associated window gets scrolled to the same line. Ftc-scroll-up Scroll current window upward by ARG screens. The associated window gets scrolled to the same line. Ftc-scroll-down Scroll current window downward by ARG screens. The associated window gets scrolled to the same line. Ftc-recenter Center point in window. With ARG, put point on line ARG. This counts from bottom if ARG is negative. The associated window gets scrolled to the same line. Fview-file Find FILE, enter view mode. With prefix arg OTHER-P, use other window. Fview-buffer Switch to BUF, enter view mode. With prefix arg use other window. Fview-file-other-window Find FILE in other window, and enter view mode. Fview-buffer-other-window Switch to BUFFER in another window, and enter view mode. Fview-minor-mode Minor mode for viewing text, with bindings like `less'. Commands are: \<view-minor-mode-map> 0..9 prefix args - prefix minus \[scroll-up] page forward \[scroll-down] page back \[view-scroll-lines-up] scroll prefix-arg lines forward, default 1. \[view-scroll-lines-down] scroll prefix-arg lines backward, default 1. \[view-scroll-some-lines-down] scroll prefix-arg lines backward, default 10. \[view-scroll-some-lines-up] scroll prefix-arg lines forward, default 10. \[what-line] print line number \[view-mode-describe] print this help message \[view-search-forward] regexp search, uses previous string if you just hit RET \[view-search-backward] as above but searches backward \[view-repeat-search] repeat last search \[view-goto-line] goto line prefix-arg, default 1 \[view-last-windowful] goto line prefix-arg, default last line \[view-goto-percent] goto a position by percentage \[toggle-truncate-lines] toggle truncate-lines \[view-file] view another file \[view-buffer] view another buffer \[view-cleanup-backspaces] cleanup backspace constructions \[shell-command] execute a shell command \[shell-command-on-region] execute a shell command with the region as input \[view-quit] exit view-mode, and bury the current buffer. If invoked with the optional (prefix) arg non-nil, view-mode cleans up backspace constructions. More precisely: \{view-minor-mode-map} Fview-mode View the current buffer using view-minor-mode. This exists to be 99.9% compatible with the implementations of `view-mode' in view.el and older versions of view-less.el. Fxpm-mode Treat the current buffer as an xpm file and colorize it. Shift-button-1 lets you paint by dragging the mouse. Shift-button-1 on a color definition line will change the current painting color to that line's value. Characters inserted from the keyboard will NOT be colored properly yet. Use the mouse, or do xpm-init (\[xpm-init]) after making changes. \[xpm-add-color] Add a new color, prompting for character and value \[xpm-show-image] show the current image at the top of the buffer \[xpm-parse-color] parse the current line's color definition and add it to the color table. Provided as a means of changing colors. XPM minor mode bindings: \{xpm-mode-map} Fbr-env-browse Invoke the OO-Browser on ENV-FILE. Fbr-env-load Load browser Environment or spec from optional ENV-FILE or 'br-env-file'. Non-nil PROMPT means prompt user before building tables. Non-nil NO-BUILD means skip build of Environment entirely. Return t if load is successful, else nil. Foobr Prompt for a language over which to run the OO-Browser. Optional prefix argument OPEN-ENV-FLAG prompts for an OO-Browser environment to open or for a new environment to be specified. Fbr-add-class-file Add a file of classes to the current Environment. Interactively or when optional CLASS-PATH is nil, CLASS-PATH defaults to the current buffer file pathname. If optional LIB-TABLE-P is non-nil, add to Library Environment, otherwise add to System Environment. If optional SAVE-FILE is t, the Environment is then stored to the filename given by 'br-env-file'. If SAVE-FILE is non-nil and not t, its string value is used as the file to which to save the Environment. Fbr-to-from-viewer Move point to viewer window or back to last recorded listing window. Fc++-browse Invoke the C++ OO-Browser. This allows browsing through C++ library and system class hierarchies. With an optional non-nil prefix argument ENV-FILE, prompt for Environment file to use. Alternatively, a string value of ENV-FILE is used as the Environment file name. See also the file "br-help". Fclos-browse Invoke the CLOS OO-Browser. This allows browsing through CLOS library and system class hierarchies. With an optional non-nil prefix argument ENV-FILE, prompt for Environment file to use. Alternatively, a string value of ENV-FILE is used as the Environment file name. See also the file "br-help". Feif-browse Invoke the Eiffel OO-Browser. This allows browsing through Eiffel library and system class hierarchies. With an optional prefix arg ENV-FILE equal to t, prompt for Environment file to use. Alternatively, a string value of ENV-FILE is used as the Environment file name. See also the file "br-help". Finfo-browse Invoke the Info OO-Browser. This allows browsing through Info library and system class hierarchies. With an optional non-nil prefix argument ENV-FILE, prompt for Environment file to use. Alternatively, a string value of ENV-FILE is used as the Environment file name. See also the file "br-help". Fjava-browse Invoke the Java OO-Browser. This allows browsing through Java library and system class hierarchies. With an optional non-nil prefix argument ENV-FILE, prompt for Environment file to use. Alternatively, a string value of ENV-FILE is used as the Environment file name. See also the file "br-help". Fobjc-browse Invoke the Objective-C OO-Browser. This allows browsing through Objective-C library and system class hierarchies. With an optional non-nil prefix argument ENV-FILE, prompt for Environment file to use. Alternatively, a string value of ENV-FILE is used as the Environment file name. See also the file "br-help". Fsmt-browse Invoke the Smalltalk OO-Browser. This allows browsing through Smalltalk library and system class hierarchies. With an optional non-nil prefix argument ENV-FILE, prompt for Environment file to use. Alternatively, a string value of ENV-FILE is used as the Environment file name. See also the file "br-help". Vchange-log-default-name *Name of a change log file for \[add-change-log-entry]. Vadd-log-current-defun-function *If non-nil, function to guess name of current function from surrounding text. \[add-change-log-entry] calls this function (if nil, `add-log-current-defun' instead) with no arguments. It returns a string or nil if it cannot guess. Vadd-log-full-name *Full name of user, for inclusion in ChangeLog daily headers. This defaults to the value returned by the `user-full-name' function. Vadd-log-mailing-address *Electronic mail address of user, for inclusion in ChangeLog daily headers. This defaults to the value of `user-mail-address'. Fprompt-for-change-log-name Prompt for a change log name. Ffind-change-log Find a change log file for \[add-change-log-entry] and return the name. Optional arg FILE-NAME specifies the file to use. If FILE-NAME is nil, use the value of `change-log-default-name' if non-nil. Otherwise, search in the current directory and its successive parents for a file named `ChangeLog' (or whatever we use on this operating system). Once a file is found, `change-log-default-name' is set locally in the current buffer to the complete file name. Fadd-change-log-entry Find change log file and add an entry for today. Optional arg (interactive prefix) non-nil means prompt for user name and site. Second arg is file name of change log. If nil, uses `change-log-default-name'. Third arg OTHER-WINDOW non-nil means visit in other window. Fourth arg NEW-ENTRY non-nil means always create a new entry at the front; never append to an existing entry. Fadd-change-log-entry-other-window Find change log file in other window and add an entry for today. Optional arg (interactive prefix) non-nil means prompt for user name and site. Second arg is file name of change log. If nil, uses `change-log-default-name'. Fchange-log-mode Major mode for editing change logs; like Indented Text Mode. Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74. New log entries are usually made with \[add-change-log-entry] or \[add-change-log-entry-other-window]. Each entry behaves as a paragraph, and the entries for one day as a page. Runs `change-log-mode-hook'. Fadd-log-current-defun Return name of function definition point is in, or nil. Understands C, Lisp, LaTeX ("functions" are chapters, sections, ...), Texinfo (@node titles), and Fortran. Other modes are handled by a heuristic that looks in the 10K before point for uppercase headings starting in the first column or identifiers followed by `:' or `=', see variable `add-log-current-defun-header-regexp'. Has a preference of looking backwards. Fapropos Show all symbols whose names contain matches for REGEXP. If optional argument DO-ALL is non-nil, does more (time-consuming) work such as showing key bindings. Optional argument PRED is called with each symbol, and if it returns nil, the symbol is not shown. Returns list of symbols and documentation found. Fsuper-apropos Show symbols whose names/documentation contain matches for REGEXP. If optional argument DO-ALL is non-nil, does more (time-consuming) work such as showing key bindings and documentation that is not stored in the documentation file. Returns list of symbols and documentation found. Vbookmark-map Keymap containing bindings to bookmark functions. It is not bound to any key by default: to bind it so that you have a bookmark prefix, just use `global-set-key' and bind a key of your choice to `bookmark-map'. All interactive bookmark functions have a binding in this keymap. Fbookmark-set Set a bookmark named NAME inside a file. If name is nil, then the user will be prompted. With prefix arg, will not overwrite a bookmark that has the same name as NAME if such a bookmark already exists, but instead will "push" the new bookmark onto the bookmark alist. Thus the most recently set bookmark with name NAME would be the one in effect at any given time, but the others are still there, should you decide to delete the most recent one. To yank words from the text of the buffer and use them as part of the bookmark name, type C-w while setting a bookmark. Successive C-w's yank successive words. Typing C-u inserts the name of the last bookmark used in the buffer (as an aid in using a single bookmark name to track your progress through a large file). If no bookmark was used, then C-u inserts the name of the file being visited. Use \[bookmark-delete] to remove bookmarks (you give it a name, and it removes only the first instance of a bookmark with that name from the list of bookmarks.) Fbookmark-jump Jump to bookmark BOOKMARK (a point in some file). You may have a problem using this function if the value of variable `bookmark-alist' is nil. If that happens, you need to load in some bookmarks. See help on function `bookmark-load' for more about this. If the file pointed to by BOOKMARK no longer exists, you will be asked if you wish to give the bookmark a new location, and bookmark-jump will then jump to the new location, as well as recording it in place of the old one in the permanent bookmark record. Fbookmark-relocate Relocate BOOKMARK -- prompts for a filename, and makes an already existing bookmark point to that file, instead of the one it used to point at. Useful when a file has been renamed after a bookmark was set in it. Fbookmark-insert-location Insert the name of the file associated with BOOKMARK. Optional second arg NO-HISTORY means don't record this in the minibuffer history list `bookmark-history'. Fbookmark-rename Change the name of OLD bookmark to NEW name. If called from keyboard, prompts for OLD and NEW. If called from menubar, OLD is selected from a menu, and prompts for NEW. If called from Lisp, prompts for NEW if only OLD was passed as an argument. If called with two strings, then no prompting is done. You must pass at least OLD when calling from Lisp. While you are entering the new name, consecutive C-w's insert consectutive words from the text of the buffer into the new bookmark name. Fbookmark-insert Insert the text of the file pointed to by bookmark BOOKMARK. You may have a problem using this function if the value of variable `bookmark-alist' is nil. If that happens, you need to load in some bookmarks. See help on function `bookmark-load' for more about this. Fbookmark-delete Delete BOOKMARK from the bookmark list. Removes only the first instance of a bookmark with that name. If there are one or more other bookmarks with the same name, they will not be deleted. Defaults to the "current" bookmark (that is, the one most recently used in this file, if any). Optional second arg BATCH means don't update the bookmark list buffer, probably because we were called from there. Fbookmark-write Write bookmarks to a file (for which the user will be prompted interactively). Don't use this in Lisp programs; use bookmark-save instead. Fbookmark-save Save currently defined bookmarks. Saves by default in the file defined by the variable `bookmark-default-file'. With a prefix arg, save it in file FILE (second argument). If you are calling this from Lisp, the two arguments are PREFIX-ARG and FILE, and if you just want it to write to the default file, then pass no arguments. Or pass in nil and FILE, and it will save in FILE instead. If you pass in one argument, and it is non-nil, then the user will be interactively queried for a file to save in. When you want to load in the bookmarks from a file, use `bookmark-load', \[bookmark-load]. That function will prompt you for a file, defaulting to the file defined by variable `bookmark-default-file'. Fbookmark-load Load bookmarks from FILE (which must be in bookmark format). Appends loaded bookmarks to the front of the list of bookmarks. If optional second argument REVERT is non-nil, existing bookmarks are destroyed. Optional third arg NO-MSG means don't display any messages while loading. If you load a file that doesn't contain a proper bookmark alist, you will corrupt Emacs's bookmark list. Generally, you should only load in files that were created with the bookmark functions in the first place. Your own personal bookmark file, `~/.emacs.bmk', is maintained automatically by Emacs; you shouldn't need to load it explicitly. Fbookmark-bmenu-list Display a list of existing bookmarks. The list is displayed in a buffer named `*Bookmark List*'. The leftmost column displays a D if the bookmark is flagged for deletion, or > if it is flagged for displaying. Fbookmark-menu-insert Insert the text of the file pointed to by bookmark BOOKMARK. You may have a problem using this function if the value of variable `bookmark-alist' is nil. If that happens, you need to load in some bookmarks. See help on function `bookmark-load' for more about this. Warning: this function only takes an EVENT as argument. Use the corresponding bookmark function from Lisp (the one without the "-menu-" in its name). Fbookmark-menu-jump Jump to bookmark BOOKMARK (a point in some file). You may have a problem using this function if the value of variable `bookmark-alist' is nil. If that happens, you need to load in some bookmarks. See help on function `bookmark-load' for more about this. Warning: this function only takes an EVENT as argument. Use the corresponding bookmark function from Lisp (the one without the "-menu-" in its name). Fbookmark-menu-locate Insert the name of the file associated with BOOKMARK. (This is not the same as the contents of that file). Warning: this function only takes an EVENT as argument. Use the corresponding bookmark function from Lisp (the one without the "-menu-" in its name). Fbookmark-menu-rename Change the name of OLD-BOOKMARK to NEWNAME. If called from keyboard, prompts for OLD-BOOKMARK and NEWNAME. If called from menubar, OLD-BOOKMARK is selected from a menu, and prompts for NEWNAME. If called from Lisp, prompts for NEWNAME if only OLD-BOOKMARK was passed as an argument. If called with two strings, then no prompting is done. You must pass at least OLD-BOOKMARK when calling from Lisp. While you are entering the new name, consecutive C-w's insert consectutive words from the text of the buffer into the new bookmark name. Warning: this function only takes an EVENT as argument. Use the corresponding bookmark function from Lisp (the one without the "-menu-" in its name). Fbookmark-menu-delete Delete the bookmark named NAME from the bookmark list. Removes only the first instance of a bookmark with that name. If there are one or more other bookmarks with the same name, they will not be deleted. Defaults to the "current" bookmark (that is, the one most recently used in this file, if any). Warning: this function only takes an EVENT as argument. Use the corresponding bookmark function from Lisp (the one without the "-menu-" in its name). Frepeat-matching-complex-command Edit and re-evaluate complex command with name matching PATTERN. Matching occurrences are displayed, most recent first, until you select a form for evaluation. If PATTERN is empty (or nil), every form in the command history is offered. The form is placed in the minibuffer for editing and the result is evaluated. Flist-command-history List history of commands typed to minibuffer. The number of commands listed is controlled by `list-command-history-max'. Calls value of `list-command-history-filter' (if non-nil) on each history element to judge if that element should be excluded from the list. The buffer is left in Command History mode. Fcommand-history-mode Major mode for examining commands from `command-history'. The number of commands listed is controlled by `list-command-history-max'. The command history is filtered by `list-command-history-filter' if non-nil. Use \<command-history-map>\[command-history-repeat] to repeat the command on the current line. Otherwise much like Emacs-Lisp Mode except that there is no self-insertion and digits provide prefix arguments. Tab does not indent. \{command-history-map} Calls the value of `command-history-hook' if that is non-nil. The Command History listing is recomputed each time this mode is invoked. Fdisplay-column-mode Toggle display column mode. With prefix arg, turn display column mode on iff arg is positive. When display column mode is on, the current column and line number are displayed in the mode line. Fcompare-windows Compare text in current window with text in next window. Compares the text starting at point in each window, moving over text in each one as far as they match. A prefix arg means ignore changes in whitespace. The variable `compare-windows-whitespace' controls how whitespace is skipped. If `compare-ignore-case' is non-nil, changes in case are also ignored. Vcompilation-mode-hook *List of hook functions run by `compilation-mode' (see `run-hooks'). Vcompilation-window-height *Number of lines in a compilation window. If nil, use Emacs default. Vcompilation-buffer-name-function Function to compute the name of a compilation buffer. The function receives one argument, the name of the major mode of the compilation buffer. It should return a string. nil means compute the name with `(concat "*" (downcase major-mode) "*")'. Vcompilation-finish-function *Function to call when a compilation process finishes. It is called with two arguments: the compilation buffer, and a string describing how the process finished. Vcompilation-search-path *List of directories to search for source files named in error messages. Elements should be directory names, not file names of directories. nil as an element means to try the default directory. Fcompile Compile the program including the current buffer. Default: run `make'. Runs COMMAND, a shell command, in a separate process asynchronously with output going to the buffer `*compilation*'. You can then use the command \[next-error] to find the next error message and move to the source code that caused it. To run more than one compilation at once, start one and rename the `*compilation*' buffer to some other name with \[rename-buffer]. Then start the next one. The name used for the buffer is actually whatever is returned by the function in `compilation-buffer-name-function', so you can set that to a function that generates a unique name. Fgrep Run grep, with user-specified args, and collect output in a buffer. While grep runs asynchronously, you can use the \[next-error] command to find the text that grep hits refer to. This command uses a special history list for its arguments, so you can easily repeat a grep command. Fcompilation-minor-mode Toggle compilation minor mode. With arg, turn compilation mode on if and only if arg is positive. See `compilation-mode'. ! \{compilation-mode-map} Fnext-error Visit next compilation error message and corresponding source code. This operates on the output from the \[compile] command. If all preparsed error messages have been processed, the error message buffer is checked for new ones. A prefix arg specifies how many error messages to move; negative means move back to previous error messages. Just C-u as a prefix means reparse the error message buffer and start at the first error. \[next-error] normally applies to the most recent compilation started, but as long as you are in the middle of parsing errors from one compilation output buffer, you stay with that compilation output buffer. Use \[next-error] in a compilation output buffer to switch to processing errors from that compilation. See variables `compilation-parse-errors-function' and `compilation-error-regexp-alist' for customization ideas. Fprevious-error Visit previous compilation error message and corresponding source code. This operates on the output from the \[compile] command. Ffirst-error Reparse the error message buffer and start at the first error Visit corresponding source code. This operates on the output from the \[compile] command. Fdabbrev-completion Completion on current word. Like \[dabbrev-expand] but finds all expansions in the current buffer and presents suggestions for completion. With a prefix argument, it searches all buffers accepted by the function pointed out by `dabbrev-friend-buffer-function' to find the completions. If the prefix argument is 16 (which comes from C-u C-u), then it searches *all* buffers. With no prefix argument, it reuses an old completion list if there is a suitable one already. Fdabbrev-expand Expand previous word "dynamically". Expands to the most recent, preceding word for which this is a prefix. If no suitable preceding word is found, words following point are considered. If still no suitable word is found, then look in the buffers accepted by the function pointed out by variable `dabbrev-friend-buffer-function'. A positive prefix argument, N, says to take the Nth backward *distinct* possibility. A negative argument says search forward. If the cursor has not moved from the end of the previous expansion and no argument is given, replace the previously-made expansion with the next possible expansion not yet tried. The variable `dabbrev-backward-only' may be used to limit the direction of search to backward if set non-nil. See also `dabbrev-abbrev-char-regexp' and \[dabbrev-completion]. Vdiff-switches *A string or list of strings specifying switches to be be passed to diff. Fdiff Find and display the differences between OLD and NEW files. Interactively the current buffer's file name is the default for NEW and a backup file for NEW is the default for OLD. With prefix arg, prompt for diff switches. Fdiff-backup Diff this file with its backup file or vice versa. Uses the latest backup, if there are several numerical backups. If this file is a backup, diff it with its original. The backup file is the first file given to `diff'. Fediff-patch-file Run Ediff by patching FILE-TP-PATCH. Fediff-files Run Ediff on a pair of files, FILE-A and FILE-B. Fediff-files3 Run Ediff on three files, FILE-A, FILE-B, and FILE-C. Fediff-buffers Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B. Fediff-buffers3 Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C. Fediff-directories Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have the same name in both. The third argument, REGEXP, is a regular expression that further filters the file names. Fediff-directory-revisions Run Ediff on a directory, DIR1, comparing its files with their revisions. The second argument, REGEXP, is a regular expression that filters the file names. Only the files that are under revision control are taken into account. Fediff-directories3 Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that have the same name in all three. The last argument, REGEXP, is a regular expression that further filters the file names. Fediff-merge-directories Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have the same name in both. The third argument, REGEXP, is a regular expression that further filters the file names. Fediff-merge-directories-with-ancestor Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have the same name in both. The third argument, REGEXP, is a regular expression that further filters the file names. Fediff-merge-directory-revisions Run Ediff on a directory, DIR1, merging its files with their revisions. The second argument, REGEXP, is a regular expression that filters the file names. Only the files that are under revision control are taken into account. Fediff-merge-directory-revisions-with-ancestor Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors. The second argument, REGEXP, is a regular expression that filters the file names. Only the files that are under revision control are taken into account. Fediff-windows-wordwise Compare WIND-A and WIND-B, which are selected by clicking, wordwise. With prefix argument, DUMB-MODE, or on a non-windowing display, works as follows: If WIND-A is nil, use selected window. If WIND-B is nil, use window next to WIND-A. Fediff-windows-linewise Compare WIND-A and WIND-B, which are selected by clicking, linewise. With prefix argument, DUMB-MODE, or on a non-windowing display, works as follows: If WIND-A is nil, use selected window. If WIND-B is nil, use window next to WIND-A. Fediff-regions-wordwise Run Ediff on a pair of regions in two different buffers. Regions (i.e., point and mark) are assumed to be set in advance. This function is effective only for relatively small regions, up to 200 lines. For large regions, use `ediff-regions-linewise'. Fediff-regions-linewise Run Ediff on a pair of regions in two different buffers. Regions (i.e., point and mark) are assumed to be set in advance. Each region is enlarged to contain full lines. This function is effective for large regions, over 100-200 lines. For small regions, use `ediff-regions-wordwise'. Fediff-merge-files Merge two files without ancestor. Fediff-merge-files-with-ancestor Merge two files with ancestor. Fediff-merge-buffers Merge buffers without ancestor. Fediff-merge-buffers-with-ancestor Merge buffers with ancestor. Fediff-merge-revisions Run Ediff by merging two revisions of a file. The file is the optional FILE argument or the file visited by the current buffer. Fediff-merge-revisions-with-ancestor Run Ediff by merging two revisions of a file with a common ancestor. The file is the the optional FILE argument or the file visited by the current buffer. Fediff-patch-buffer Run Ediff by patching BUFFER-NAME. Fediff-revision Run Ediff by comparing versions of a file. The file is an optional FILE argument or the file visited by the current buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'. Fedit-faces Alter face characteristics by editing a list of defined faces. Pops up a buffer containing a list of defined faces. Editing commands: \{edit-faces-map} Freport-emacs-bug Report a bug in GNU Emacs. Prompts for bug subject. Leaves you in a mail buffer. Femerge-files Run Emerge on two files. Femerge-files-with-ancestor Run Emerge on two files, giving another file as the ancestor. Femerge-buffers Run Emerge on two buffers. Femerge-buffers-with-ancestor Run Emerge on two buffers, giving another buffer as the ancestor. Femerge-revisions Emerge two RCS revisions of a file. Femerge-revisions-with-ancestor Emerge two RCS revisions of a file, with another revision as ancestor. Vtags-build-completion-table *If this variable is nil, then tags completion is disabled. If this variable is t, then things which prompt for tags will do so with completion across all known tags. If this variable is the symbol `ask', then you will be asked whether each tags table should be added to the completion list as it is read in. (With the exception that for very small tags tables, you will not be asked, since they can be parsed quickly.) Vtags-always-exact *If this variable is non-nil, then tags always looks for exact matches. Vtag-table-alist *A list which determines which tags files should be active for a given buffer. This is not really an association list, in that all elements are checked. The CAR of each element of this list is a pattern against which the buffer's file name is compared; if it matches, then the CDR of the list should be the name of the tags table to use. If more than one element of this list matches the buffer's file name, then all of the associated tags tables will be used. Earlier ones will be searched first. If the CAR of elements of this list are strings, then they are treated as regular-expressions against which the file is compared (like the auto-mode-alist). If they are not strings, then they are evaluated. If they evaluate to non-nil, then the current buffer is considered to match. If the CDR of the elements of this list are strings, then they are assumed to name a TAGS file. If they name a directory, then the string "TAGS" is appended to them to get the file name. If they are not strings, then they are evaluated, and must return an appropriate string. For example: (setq tag-table-alist '(("/usr/src/public/perl/" . "/usr/src/public/perl/perl-3.0/") ("\\.el$" . "/usr/local/emacs/src/") ("/jbw/gnu/" . "/usr15/degree/stud/jbw/gnu/") ("" . "/usr/local/emacs/src/") )) This means that anything in the /usr/src/public/perl/ directory should use the TAGS file /usr/src/public/perl/perl-3.0/TAGS; and file ending in .el should use the TAGS file /usr/local/emacs/src/TAGS; and anything in or below the directory /jbw/gnu/ should use the TAGS file /usr15/degree/stud/jbw/gnu/TAGS. A file called something like "/usr/jbw/foo.el" would use both the TAGS files /usr/local/emacs/src/TAGS and /usr15/degree/stud/jbw/gnu/TAGS (in that order) because it matches both patterns. If the buffer-local variable `buffer-tag-table' is set, then it names a tags table that is searched before all others when find-tag is executed from this buffer. If there is a file called "TAGS" in the same directory as the file in question, then that tags file will always be used as well (after the `buffer-tag-table' but before the tables specified by this list.) If the variable tags-file-name is set, then the tags file it names will apply to all buffers (for backwards compatibility.) It is searched first. Fvisit-tags-table Tell tags commands to use tags table file FILE first. FILE should be the name of a file created with the `etags' program. A directory name is ok too; it means file TAGS in that directory. Ffind-tag *Find tag whose name contains TAGNAME. Selects the buffer that the tag is contained in and puts point at its definition. If TAGNAME is a null string, the expression in the buffer around or before point is used as the tag name. If called interactively with a numeric argument, searches for the next tag in the tag table that matches the tagname used in the previous find-tag. If second arg OTHER-WINDOW is non-nil, uses another window to display the tag. This version of this function supports multiple active tags tables, and completion. Variables of note: tag-table-alist controls which tables apply to which buffers tags-file-name a default tags table tags-build-completion-table controls completion behavior buffer-tag-table another way of specifying a buffer-local table make-tags-files-invisible whether tags tables should be very hidden tag-mark-stack-max how many tags-based hops to remember Ffind-tag-other-window *Find tag whose name contains TAGNAME. Selects the buffer that the tag is contained in in another window and puts point at its definition. If TAGNAME is a null string, the expression in the buffer around or before point is used as the tag name. If second arg NEXT is non-nil (interactively, with prefix arg), searches for the next tag in the tag table that matches the tagname used in the previous find-tag. This version of this function supports multiple active tags tables, and completion. Variables of note: tag-table-alist controls which tables apply to which buffers tags-file-name a default tags table tags-build-completion-table controls completion behavior buffer-tag-table another way of specifying a buffer-local table make-tags-files-invisible whether tags tables should be very hidden tag-mark-stack-max how many tags-based hops to remember Fnext-file Select next file among files in current tag table(s). A first argument of t (prefix arg, if interactive) initializes to the beginning of the list of files in the (first) tags table. If the argument is neither nil nor t, it is evalled to initialize the list of files. Non-nil second argument NOVISIT means use a temporary buffer to save time and avoid uninteresting warnings. Value is nil if the file was already visited; if the file was newly read in, the value is the filename. Ftags-loop-continue Continue last \[tags-search] or \[tags-query-replace] command. Used noninteractively with non-nil argument to begin such a command (the argument is passed to `next-file', which see). Two variables control the processing we do on each file: the value of `tags-loop-scan' is a form to be executed on each file to see if it is interesting (it returns non-nil if so) and `tags-loop-operate' is a form to execute to operate on an interesting file If the latter returns non-nil, we exit; otherwise we scan the next file. Ftags-search Search through all files listed in tags table for match for REGEXP. Stops when a match is found. To continue searching for next match, use command \[tags-loop-continue]. See documentation of variable `tag-table-alist'. Ftags-query-replace Query-replace-regexp FROM with TO through all files listed in tags table. Third arg DELIMITED (prefix arg) means replace only word-delimited matches. If you exit (\[keyboard-quit] or ESC), you can resume the query-replace with the command \[tags-loop-continue]. See documentation of variable `tag-table-alist'. Flist-tags Display list of tags in file FILE. FILE should not contain a directory spec unless it has one in the tag table. Ftags-apropos Display list of all tags in tag table REGEXP matches. Ffast-lock-mode Toggle Fast Lock mode. With arg, turn Fast Lock mode on if and only if arg is positive and the buffer is associated with a file. Enable it automatically in your `~/.emacs' by: (add-hook 'font-lock-mode-hook 'turn-on-fast-lock) If Fast Lock mode is enabled, and the current buffer does not contain any text properties, any associated Font Lock cache is used if its timestamp matches the buffer's file, and its `font-lock-keywords' match those that you are using. Font Lock caches may be saved: - When you save the file's buffer. - When you kill an unmodified file's buffer. - When you exit Emacs, for all unmodified or saved buffers. Depending on the value of `fast-lock-save-events'. See also the commands `fast-lock-read-cache' and `fast-lock-save-cache'. Use \[font-lock-fontify-buffer] to fontify the buffer if the cache is bad. Various methods of control are provided for the Font Lock cache. In general, see variable `fast-lock-cache-directories' and function `fast-lock-cache-name'. For saving, see variables `fast-lock-minimum-size', `fast-lock-save-events', `fast-lock-save-others' and `fast-lock-save-faces'. Use \[fast-lock-submit-bug-report] to send bug reports or feedback. Fturn-on-fast-lock Unconditionally turn on Fast Lock mode. Fmake-file-part Make a file part on buffer BUFFER out of the region. Call it NAME. This command creates a new buffer containing the contents of the region and marks the buffer as referring to the specified buffer, called the `master buffer'. When the file-part buffer is saved, its changes are integrated back into the master buffer. When the master buffer is deleted, all file parts are deleted with it. When called from a function, expects four arguments, START, END, NAME, and BUFFER, all of which are optional and default to the beginning of BUFFER, the end of BUFFER, a name generated from BUFFER's name, and the current buffer, respectively. Vfont-lock-keywords *The keywords to highlight. If this is a list, then elements may be of the forms: "string" ; a regexp to highlight in the ; `font-lock-keyword-face'. ("string" . integer) ; match N of the regexp will be highlighted ("string" . face-name) ; use the named face ("string" integer face-name) ; both of the above ("string" integer face-name t) ; this allows highlighting to overlap ; with already-highlighted regions. These regular expressions should not match text which spans lines. Multi-line patterns will be correctly fontified when \[font-lock-fontify-buffer] is used, but will not be matched by the auto-fontification that font-lock-mode does, since it looks at only one line at a time. Be careful composing regexps for this list; the wrong pattern can dramatically slow things down! Vfont-lock-auto-fontify *Whether font-lock should automatically fontify files as they're loaded. This will only happen if font-lock has fontifying keywords for the major mode of the file. You can get finer-grained control over auto-fontification by using this variable in combination with `font-lock-mode-enable-list' or `font-lock-mode-disable-list'. Vfont-lock-mode-enable-list *List of modes to auto-fontify, if `font-lock-auto-fontify' is nil. Vfont-lock-mode-disable-list *List of modes not to auto-fontify, if `font-lock-auto-fontify' is t. Vfont-lock-use-colors *If true, font-lock will by default use colors to fontify text. Set this *before* loading font-lock (e.g. in your init file). You can also explicitly reset the font-lock faces to these colors at any time by calling the function `font-lock-use-default-colors'. See also `font-lock-use-fonts'. If you want more control over the faces used for fontification, see the documentation of `font-lock-mode' for how to do it. In such a case, you might want to consider setting both `font-lock-use-colors' and `font-lock-use-fonts' to nil to prevent font-lock from initializing the faces. Vfont-lock-use-fonts *If true, font-lock will by default use different fonts to fontify text. Set this *before* loading font-lock (e.g. in your init file). You can also explicitly reset the font-lock faces to these fonts at any time by calling the function `font-lock-use-default-fonts'. See also `font-lock-use-colors'. If you want more control over the faces used for fontification, see the documentation of `font-lock-mode' for how to do it. In such a case, you might want to consider setting both `font-lock-use-colors' and `font-lock-use-fonts' to nil to prevent font-lock from initializing the faces. Vfont-lock-use-maximal-decoration *If true, font-lock will use a larger set of decorations than normal. Set this *before* loading font-lock (e.g. in your init file). This typically results in keywords being fontified as well as comments and strings and such; however, fontification will take longer. If you want to change this when font-lock is already loaded, use the functions `font-lock-use-default-minimal-decoration' or `font-lock-use-default-maximal-decoration'. Ffont-lock-mode Toggle Font Lock Mode. With arg, turn font-lock mode on if and only if arg is positive. In the font-lock minor mode, text is fontified as you type it: - comments are displayed in font-lock-comment-face; - strings are displayed in font-lock-string-face; - documentation strings are displayed in font-lock-doc-string-face; - function and variable names in their defining forms are displayed in font-lock-function-name-face; - and certain other expressions are displayed in other faces according to the value of the variable `font-lock-keywords'. When font-lock mode is turned on/off, the buffer is fontified/defontified. To fontify a buffer without having newly typed text become fontified, you can use \[font-lock-fontify-buffer]. See the variable `font-lock-keywords' for customization. Fturn-on-font-lock Unconditionally turn on Font Lock mode. Ffont-lock-fontify-buffer Fontify the current buffer the way `font-lock-mode' would: - comments are displayed in font-lock-comment-face; - strings are displayed in font-lock-string-face; - documentation strings are displayed in font-lock-doc-string-face; - function and variable names in their defining forms are displayed in font-lock-function-name-face; - and certain other expressions are displayed in other faces according to the value of the variable `font-lock-keywords'. This can take a while for large buffers. Fsc-mode Toggle sc-mode. SYSTEM can be sccs, rcs or cvs. Cvs requires the pcl-cvs package. The following commands are available \[sc-next-operation] perform next logical source control operation on current file \[sc-show-changes] compare the version being edited with an older one \[sc-version-diff-file] compare two older versions of a file \[sc-show-history] display change history of current file \[sc-visit-previous-revision] display an older revision of current file \[sc-revert-file] revert buffer to last checked-in version \[sc-list-all-locked-files] show all files locked in current directory \[sc-list-locked-files] show all files locked by you in current directory \[sc-list-registered-files] show all files under source control in current directory \[sc-update-directory] get fresh copies of files checked-in by others in current directory \[sc-rename-file] rename the current file and its source control file While you are entering a change log message for a check in, sc-log-entry-mode will be in effect. Global user options: sc-diff-command A list consisting of the command and flags to be used for generating context diffs. sc-mode-expert suppresses some conformation prompts, notably for delta aborts and file saves. sc-max-log-size specifies the maximum allowable size of a log message plus one. When using SCCS you have additional commands and options \[sccs-insert-headers] insert source control headers in current file When you generate headers into a buffer using \[sccs-insert-headers], the value of sc-insert-headers-hook is called before insertion. If the file is recognized a C or Lisp source, sc-insert-c-header-hook or sc-insert-lisp-header-hook is called after insertion respectively. sccs-headers-wanted which %-keywords to insert when adding headers with C-c h sccs-insert-static if non-nil, keywords inserted in C files get stuffed in a static string area so that what(1) can see them in the compiled object code. When using CVS you have additional commands \[sc-cvs-update-directory] update the current directory using pcl-cvs \[sc-cvs-file-status] show the CVS status of current file Fgnuserv-start Allow this Emacs process to be a server for client processes. This starts a server communications subprocess through which client "editors" (gnuclient and gnudoit) can send editing commands to this Emacs job. See the gnuserv(1) manual page for more details. Prefix arg means just kill any existing server communications subprocess. Fgopher Start a gopher session. With C-u, prompt for a gopher server. Fgopher-atpoint Try to interpret the text around point as a gopher bookmark, and dispatch to that object. Fhexl-mode \<hexl-mode-map> A major mode for editing binary files in hex dump format. This function automatically converts a buffer into the hexl format using the function `hexlify-buffer'. Each line in the buffer has an "address" (displayed in hexadecimal) representing the offset into the file that the characters on this line are at and 16 characters from the file (displayed as hexadecimal values grouped every 16 bits) and as their ASCII values. If any of the characters (displayed as ASCII characters) are unprintable (control or meta characters) they will be replaced as periods. If `hexl-mode' is invoked with an argument the buffer is assumed to be in hexl format. A sample format: HEX ADDR: 0001 0203 0405 0607 0809 0a0b 0c0d 0e0f ASCII-TEXT -------- ---- ---- ---- ---- ---- ---- ---- ---- ---------------- 00000000: 5468 6973 2069 7320 6865 786c 2d6d 6f64 This is hexl-mod 00000010: 652e 2020 4561 6368 206c 696e 6520 7265 e. Each line re 00000020: 7072 6573 656e 7473 2031 3620 6279 7465 presents 16 byte 00000030: 7320 6173 2068 6578 6164 6563 696d 616c s as hexadecimal 00000040: 2041 5343 4949 0a61 6e64 2070 7269 6e74 ASCII.and print 00000050: 6162 6c65 2041 5343 4949 2063 6861 7261 able ASCII chara 00000060: 6374 6572 732e 2020 416e 7920 636f 6e74 cters. Any cont 00000070: 726f 6c20 6f72 206e 6f6e 2d41 5343 4949 rol or non-ASCII 00000080: 2063 6861 7261 6374 6572 730a 6172 6520 characters.are 00000090: 6469 7370 6c61 7965 6420 6173 2070 6572 displayed as per 000000a0: 696f 6473 2069 6e20 7468 6520 7072 696e iods in the prin 000000b0: 7461 626c 6520 6368 6172 6163 7465 7220 table character 000000c0: 7265 6769 6f6e 2e0a region.. Movement is as simple as movement in a normal emacs text buffer. Most cursor movement bindings are the same (ie. Use \[hexl-backward-char], \[hexl-forward-char], \[hexl-next-line], and \[hexl-previous-line] to move the cursor left, right, down, and up). Advanced cursor movement commands (ala \[hexl-beginning-of-line], \[hexl-end-of-line], \[hexl-beginning-of-buffer], and \[hexl-end-of-buffer]) are also supported. There are several ways to change text in hexl mode: ASCII characters (character between space (0x20) and tilde (0x7E)) are bound to self-insert so you can simply type the character and it will insert itself (actually overstrike) into the buffer. \[hexl-quoted-insert] followed by another keystroke allows you to insert the key even if it isn't bound to self-insert. An octal number can be supplied in place of another key to insert the octal number's ASCII representation. \[hexl-insert-hex-char] will insert a given hexadecimal value (if it is between 0 and 0xFF) into the buffer at the current point. \[hexl-insert-octal-char] will insert a given octal value (if it is between 0 and 0377) into the buffer at the current point. \[hexl-insert-decimal-char] will insert a given decimal value (if it is between 0 and 255) into the buffer at the current point. \[hexl-mode-exit] will exit hexl-mode. Note: saving the file with any of the usual Emacs commands will actually convert it back to binary format while saving. You can use \[hexl-find-file] to visit a file in hexl-mode. \[describe-bindings] for advanced commands. Fhexl-find-file Edit file FILENAME in hexl-mode. Switch to a buffer visiting file FILENAME, creating one in none exists. Vhypropos-show-brief-docs *If non-nil, `hyper-apropos' will display some documentation in the "*Hyper Apropos*" buffer. Setting this to nil will speed up searches. Fhyper-apropos Display lists of functions and variables matching REGEXP in buffer "*Hyper Apropos*". If optional prefix arg is given, then the value of `hypropos-programming-apropos' is toggled for this search. See also `hyper-apropos-mode'. Fhyper-describe-variable Hypertext drop-in replacement for `describe-variable'. See also `hyper-apropos' and `hyper-describe-function'. Fhyper-describe-function Hypertext replacement for `describe-function'. Unlike `describe-function' in that the symbol under the cursor is the default if it is a function. See also `hyper-apropos' and `hyper-describe-variable'. Fhypropos-set-variable Interactively set the variable on the current line. Finfo Enter Info, the documentation browser. Optional argument FILE specifies the file to examine; the default is the top-level directory of Info. In interactive use, a prefix argument directs this command to read a file name from the minibuffer. FInfo-query Enter Info, the documentation browser. Prompt for name of Info file. FInfo-emacs-command Look up an Emacs command in the Emacs manual in the Info system. This command is designed to be used whether you are already in Info or not. FInfo-goto-emacs-command-node Look up an Emacs command in the Emacs manual in the Info system. This command is designed to be used whether you are already in Info or not. FInfo-goto-emacs-key-command-node Look up an Emacs key sequence in the Emacs manual in the Info system. This command is designed to be used whether you are already in Info or not. FInfo-emacs-key Look up an Emacs key sequence in the Emacs manual in the Info system. This command is designed to be used whether you are already in Info or not. FInfo-elisp-ref Look up an Emacs Lisp function in the Elisp manual in the Info system. This command is designed to be used whether you are already in Info or not. FInfo-tagify Create or update Info-file tag table in current buffer. FInfo-split Split an info file into an indirect file plus bounded-size subfiles. Each subfile will be up to 50,000 characters plus one node. To use this command, first visit a large Info file that has a tag table. The buffer is modified into a (small) indirect info file which should be saved in place of the original visited file. The subfiles are written in the same directory the original file is in, with names generated by appending `-' and a number to the original file name. The indirect file still functions as an Info file, but it contains just the tag table and a directory of subfiles. FInfo-validate Check current buffer for validity as an Info file. Check that every node pointer points to an existing node. Fbatch-info-validate Runs `Info-validate' on the files remaining on the command line. Must be used only with -batch, and kills Emacs on completion. Each file will be processed even if an error occurred previously. For example, invoke "emacs -batch -f batch-info-validate $info/ ~/*.info" Vispell-personal-dictionary *File name of your personal spelling dictionary, or nil. If nil, the default personal dictionary, "~/.ispell_DICTNAME" is used, where DICTNAME is the name of your default dictionary. Vispell-dictionary-alist An alist of dictionaries and their associated parameters. Each element of this list is also a list: (DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P ISPELL-ARGS EXTENDED-CHARACTER-MODE) DICTIONARY-NAME is a possible value of variable `ispell-dictionary', nil means the default dictionary. CASECHARS is a regular expression of valid characters that comprise a word. NOT-CASECHARS is the opposite regexp of CASECHARS. OTHERCHARS is a regular expression of other characters that are valid in word constructs. Otherchars cannot be adjacent to each other in a word, nor can they begin or end a word. This implies we can't check "Stevens'" as a correct possessive and other correct formations. Hint: regexp syntax requires the hyphen to be declared first here. MANY-OTHERCHARS-P is non-nil if many otherchars are to be allowed in a word instead of only one. ISPELL-ARGS is a list of additional arguments passed to the ispell subprocess. EXTENDED-CHARACTER-MODE should be used when dictionaries are used which have been configured in an Ispell affix file. (For example, umlauts can be encoded as \"a, a\", "a, ...) Defaults are ~tex and ~nroff in English. This has the same effect as the command-line `-T' option. The buffer Major Mode controls Ispell's parsing in tex or nroff mode, but the dictionary can control the extended character mode. Both defaults can be overruled in a buffer-local fashion. See `ispell-parsing-keyword' for details on this. Note that the CASECHARS and OTHERCHARS slots of the alist should contain the same character set as casechars and otherchars in the language.aff file (e.g., english.aff). Vispell-menu-map Key map for ispell menu Vispell-menu-lucid Spelling menu for Lucid Emacs. Vispell-local-pdict A buffer local variable containing the current personal dictionary. If non-nil, the value must be a string, which is a file name. If you specify a personal dictionary for the current buffer which is different from the current personal dictionary, the effect is similar to calling \[ispell-change-dictionary]. This variable is automatically set when defined in the file with either `ispell-pdict-keyword' or the local variable syntax. Fispell-word Check spelling of word under or before the cursor. If the word is not found in dictionary, display possible corrections in a window allowing you to choose one. With a prefix argument (or if CONTINUE is non-nil), resume interrupted spell-checking of a buffer or region. If optional argument FOLLOWING is non-nil or if `ispell-following-word' is non-nil when called interactively, then the following word (rather than preceding) is checked when the cursor is not over a word. When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil when called interactively, non-corrective messages are suppressed. Word syntax described by `ispell-dictionary-alist' (which see). This will check or reload the dictionary. Use \[ispell-change-dictionary] or \[ispell-region] to update the Ispell process. Fispell-help Display a list of the options available when a misspelling is encountered. Selections are: DIGIT: Replace the word with a digit offered in the *Choices* buffer. SPC: Accept word this time. `i': Accept word and insert into private dictionary. `a': Accept word for this session. `A': Accept word and place in `buffer-local dictionary'. `r': Replace word with typed-in value. Rechecked. `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked. `?': Show these commands. `x': Exit spelling buffer. Move cursor to original point. `X': Exit spelling buffer. Leaves cursor at the current point, and permits the aborted check to be completed later. `q': Quit spelling session (Kills ispell process). `l': Look up typed-in replacement in alternate dictionary. Wildcards okay. `u': Like `i', but the word is lower-cased first. `m': Like `i', but allows one to include dictionary completion information. `C-l': redraws screen `C-r': recursive edit `C-z': suspend emacs or iconify frame Fispell-kill-ispell Kill current Ispell process (so that you may start a fresh one). With NO-ERROR, just return non-nil if there was no Ispell running. Fispell-change-dictionary Change `ispell-dictionary' (q.v.) and kill old Ispell process. A new one will be started as soon as necessary. By just answering RET you can find out what the current dictionary is. With prefix argument, set the default directory. Fispell-region Interactively check a region for spelling errors. Fispell-buffer Check the current buffer for spelling errors interactively. Fispell-complete-word Look up word before or under point in dictionary (see lookup-words command) and try to complete it. If optional INTERIOR-FRAG is non-nil then the word may be a character sequence inside of a word. Standard ispell choices are then available. Fispell-complete-word-interior-frag Completes word matching character sequence inside a word. Fispell-minor-mode Toggle Ispell minor mode. With prefix arg, turn Ispell minor mode on iff arg is positive. In Ispell minor mode, pressing SPC or RET warns you if the previous word is incorrectly spelled. Fispell-message Check the spelling of a mail message or news post. Don't check spelling of message headers except the Subject field. Don't check included messages. To abort spell checking of a message REGION and send the message anyway, use the `x' or `q' command. (Any subsequent regions will be checked.) The `X' command aborts the message send so that you can edit the buffer. To spell-check whenever a message is sent, include the appropriate lines in your .emacs file: (add-hook 'news-inews-hook 'ispell-message) (add-hook 'mail-send-hook 'ispell-message) (add-hook 'mh-before-send-letter-hook 'ispell-message) You can bind this to the key C-c i in GNUS or mail by adding to `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression: (function (lambda () (local-set-key "\C-ci" 'ispell-message))) Fjka-compr-load Documented as original. Ftoggle-auto-compression Toggle automatic file compression and decompression. With prefix argument ARG, turn auto compression on if positive, else off. Returns the new status of auto compression (non-nil means on). Fjka-compr-install Install jka-compr. This adds entries to `file-name-handler-alist' and `auto-mode-alist' and `inhibit-first-line-modes-suffixes'. Flazy-lock-mode Toggle Lazy Lock mode. With arg, turn Lazy Lock mode on if and only if arg is positive and the buffer is at least `lazy-lock-minimum-size' characters long. When Lazy Lock mode is enabled, fontification is demand-driven and stealthy: - Fontification occurs in visible parts of buffers when necessary. Occurs if there is no input after pausing for `lazy-lock-continuity-time'. - Fontification occurs in invisible parts when Emacs has been idle. Occurs if there is no input after pausing for `lazy-lock-stealth-time'. If `lazy-lock-hide-invisible' is non-nil, text is not displayed until it is fontified, otherwise it is displayed in `lazy-lock-invisible-foreground'. See also variables `lazy-lock-walk-windows', `lazy-lock-stealth-lines', `lazy-lock-stealth-nice' and `lazy-lock-ignore-commands'. Use \[lazy-lock-submit-bug-report] to send bug reports or feedback. Fturn-on-lazy-lock Unconditionally turn on Lazy Lock mode. Vledit-save-files *Non-nil means Ledit should save files before transferring to Lisp. Vledit-go-to-lisp-string *Shell commands to execute to resume Lisp job. Vledit-go-to-liszt-string *Shell commands to execute to resume Lisp compiler job. Fledit-mode \<ledit-mode-map>Major mode for editing text and stuffing it to a Lisp job. Like Lisp mode, plus these special commands: \[ledit-save-defun] -- record defun at or after point for later transmission to Lisp job. \[ledit-save-region] -- record region for later transmission to Lisp job. \[ledit-go-to-lisp] -- transfer to Lisp job and transmit saved text. \[ledit-go-to-liszt] -- transfer to Liszt (Lisp compiler) job and transmit saved text. \{ledit-mode-map} To make Lisp mode automatically change to Ledit mode, do (setq lisp-mode-hook 'ledit-from-lisp-mode) Vlpr-switches *List of strings to pass as extra switch args to lpr when it is invoked. Vlpr-command *Shell command for printing a file Flpr-buffer Print buffer contents as with Unix command `lpr'. `lpr-switches' is a list of extra switches (strings) to pass to lpr. Fprint-buffer Print buffer contents as with Unix command `lpr -p'. `lpr-switches' is a list of extra switches (strings) to pass to lpr. Flpr-region Print region contents as with Unix command `lpr'. `lpr-switches' is a list of extra switches (strings) to pass to lpr. Fprint-region Print region contents as with Unix command `lpr -p'. `lpr-switches' is a list of extra switches (strings) to pass to lpr. Fmc-deactivate-passwd *Deactivates the passphrase. Fmc-encrypt-message *Encrypt the message to RECIPIENTS using the given encryption SCHEME. RECIPIENTS is a comma separated string. If SCHEME is nil, use the value of `mc-default-scheme'. Returns t on success, nil otherwise. By default, this function is bound to `C-c e' in mail composing modes. Fmc-decrypt-message *Decrypt whatever message is in the current buffer. Returns a pair (SUCCEEDED . VERIFIED) where SUCCEEDED is t if the encryption succeeded and VERIFIED is t if it had a valid signature. By default, this function is bound to `C-c d' in reading modes. Fmc-sign-message *Clear sign the message. With one prefix arg, prompts for private key to use, with two prefix args, also prompts for encryption scheme to use. By default, this function is bound to `C-c s' in composition modes. Fmc-verify-signature *Verify the signature of the signed message in the current buffer. Show the result as a message in the minibuffer. Returns t if the signature is verified. By default, this function is bound to `C-c v' in reading modes. Fmc-insert-public-key *Insert your public key at the end of the current buffer. With one prefix arg, prompts for user id to use. With two prefix args, prompts for encryption scheme. Fmc-snarf-keys *Add the first public key in the buffer to your keyring. TODO: add ALL the keys in the buffer. Fmc-rmail-verify-signature *Verify the signature in the current message. Fmc-rmail-decrypt-message *Decrypt the contents of this message Fmc-vm-verify-signature *Verify the signature in the current VM message Fmc-vm-decrypt-message *Decrypt the contents of the current VM message Fmc-mh-decrypt-message *Decrypt the contents of the current MH message in the show buffer. With prefix arg, decrypt the message on disk as well. Fmc-mh-verify-signature *Verify the signature in the current MH message. Fmake-command-summary Make a summary of current key bindings in the buffer *Summary*. Previous contents of that buffer are killed first. Fmanual-entry Display the Unix manual entry (or entries) for TOPIC. If prefix arg is given, modify the search according to the value: 2 = complement default exact matching of the TOPIC name; exact matching default is specified by `Manual-match-topic-exactly' 3 = force a search of the unformatted man directories 4 = both 2 and 3 The manual entries are searched according to the variable Manual-directory-list, which should be a list of directories. If Manual-directory-list is nil, \[Manual-directory-list-init] is invoked to create this list from the MANPATH environment variable. See the variable Manual-topic-buffer which controls how the buffer is named. See also the variables Manual-match-topic-exactly, Manual-query-multiple-pages, and Manual-buffer-view-mode. Vparen-mode *Sets the style of parenthesis highlighting. Valid values are `blink-paren', `paren', and `sexp'. blink-paren causes the matching paren to blink. paren causes the matching paren to be highlighted but not to blink. sexp whole expression enclosed by the local paren at its mate. nested (not released yet) use variable shading to see the nesting of an expression. Also groks regular expressions and shell quoting. This variable is global by default, but you can make it buffer-local and highlight parentheses differrently in different major modes. Fparen-set-mode Cycles through possible values for `paren-mode', force off with negative arg. When called from lisp, a symbolic value for `paren-mode' can be pased directly. See also `paren-mode' and `paren-highlight'. Fblink-paren Obsolete. Use `paren-set-mode' instead. Fpending-delete-on Turn on pending delete. When it is ON, typed text replaces the selection if the selection is active. When it is OFF, typed text is just inserted at point. Fpending-delete-off Turn off pending delete. When it is ON, typed text replaces the selection if the selection is active. When it is OFF, typed text is just inserted at point. Fpending-delete Toggle automatic deletion of the selected region. With a positive argument, turns it on. With a non-positive argument, turns it off. When active, typed text replaces the selection. Fps-print-buffer Generate and print a PostScript image of the buffer. When called with a numeric prefix argument (C-u), prompts the user for the name of a file to save the PostScript image in, instead of sending it to the printer. More specifically, the FILENAME argument is treated as follows: if it is nil, send the image to the printer. If FILENAME is a string, save the PostScript image in a file with that name. If FILENAME is a number, prompt the user for the name of the file to save in. Fps-print-buffer-with-faces Generate and print a PostScript image of the buffer. Like `ps-print-buffer', but includes font, color, and underline information in the generated image. Fps-print-region Generate and print a PostScript image of the region. Like `ps-print-buffer', but prints just the current region. Fps-print-region-with-faces Generate and print a PostScript image of the region. Like `ps-print-region', but includes font, color, and underline information in the generated image. Fps-spool-buffer Generate and spool a PostScript image of the buffer. Like `ps-print-buffer' except that the PostScript image is saved in a local buffer to be sent to the printer later. Use the command `ps-despool' to send the spooled images to the printer. Fps-spool-buffer-with-faces Generate and spool a PostScript image of the buffer. Like `ps-spool-buffer', but includes font, color, and underline information in the generated image. Use the command `ps-despool' to send the spooled images to the printer. Fps-spool-region Generate a PostScript image of the region and spool locally. Like `ps-spool-buffer', but spools just the current region. Use the command `ps-despool' to send the spooled images to the printer. Fps-spool-region-with-faces Generate a PostScript image of the region and spool locally. Like `ps-spool-region', but includes font, color, and underline information in the generated image. Use the command `ps-despool' to send the spooled images to the printer. Fps-despool Send the spooled PostScript to the printer. When called with a numeric prefix argument (C-u), prompt the user for the name of a file to save the spooled PostScript in, instead of sending it to the printer. More specifically, the FILENAME argument is treated as follows: if it is nil, send the image to the printer. If FILENAME is a string, save the PostScript image in a file with that name. If FILENAME is a number, prompt the user for the name of the file to save in. Fremote-compile Compile the the current buffer's directory on HOST. Log in as USER. See \[compile]. Fserver-start Allow this Emacs process to be a server for client processes. This starts a server communications subprocess through which client "editors" can send your editing commands to this Emacs job. To use the server, set up the program `emacsclient' in the Emacs distribution as your standard "editor". Prefix arg means just kill any existing server communications subprocess. Finstall-shell-fonts Decorate the current interaction buffer with fonts. This uses the faces called `shell-prompt', `shell-input' and `shell-output'; you can alter the graphical attributes of those with the normal face-manipulation functions. Ftar-mode Major mode for viewing a tar file as a dired-like listing of its contents. You can move around using the usual cursor motion commands. Letters no longer insert themselves. Type 'e' to pull a file out of the tar file and into its own buffer. Type 'c' to copy an entry from the tar file into another file on disk. If you edit a sub-file of this archive (as with the 'e' command) and save it with Control-X Control-S, the contents of that buffer will be saved back into the tar-file buffer; in this way you can edit a file inside of a tar archive without extracting it and re-archiving it. See also: variables tar-update-datestamp and tar-anal-blocksize. \{tar-mode-map} Fterminal-emulator Under a display-terminal emulator in BUFFER, run PROGRAM on arguments ARGS. ARGS is a list of argument-strings. Remaining arguments are WIDTH and HEIGHT. BUFFER's contents are made an image of the display generated by that program, and any input typed when BUFFER is the current Emacs buffer is sent to that program an keyboard input. Interactively, BUFFER defaults to "*terminal*" and PROGRAM and ARGS are parsed from an input-string using your usual shell. WIDTH and HEIGHT are determined from the size of the current window -- WIDTH will be one less than the window's width, HEIGHT will be its height. To switch buffers and leave the emulator, or to give commands to the emulator itself (as opposed to the program running under it), type Control-^. The following character is an emulator command. Type Control-^ twice to send it to the subprogram. This escape character may be changed using the variable `terminal-escape-char'. `Meta' characters may not currently be sent through the terminal emulator. Here is a list of some of the variables which control the behaviour of the emulator -- see their documentation for more information: terminal-escape-char, terminal-scrolling, terminal-more-processing, terminal-redisplay-interval. This function calls the value of terminal-mode-hook if that exists and is non-nil after the terminal buffer has been set up and the subprocess started. Presently with `termcap' only; if somebody sends us code to make this work with `terminfo' we will try to use it. Ftexinfo-format-buffer Process the current buffer as texinfo code, into an Info file. The Info file output is generated in a buffer visiting the Info file names specified in the @setfilename command. Non-nil argument (prefix, if interactive) means don't make tag table and don't split the file if large. You can use Info-tagify and Info-split to do these manually. Ftexinfo-format-region Convert the current region of the Texinfo file to Info format. This lets you see what that part of the file will look like in Info. The command is bound to \[texinfo-format-region]. The text that is converted to Info is stored in a temporary buffer. Fbatch-texinfo-format Runs texinfo-format-buffer on the files remaining on the command line. Must be used only with -batch, and kills emacs on completion. Each file will be processed even if an error occurred previously. For example, invoke "emacs -batch -funcall batch-texinfo-format $docs/ ~/*.texinfo". Ftexinfo-update-node Without any prefix argument, update the node in which point is located. Non-nil argument (prefix, if interactive) means update the nodes in the marked region. The functions for creating or updating nodes and menus, and their keybindings, are: texinfo-update-node (&optional region-p) \[texinfo-update-node] texinfo-every-node-update () \[texinfo-every-node-update] texinfo-sequential-node-update (&optional region-p) texinfo-make-menu (&optional region-p) \[texinfo-make-menu] texinfo-all-menus-update () \[texinfo-all-menus-update] texinfo-master-menu () texinfo-indent-menu-description (column &optional region-p) The `texinfo-column-for-description' variable specifies the column to which menu descriptions are indented. Its default value is 32. Ftexinfo-every-node-update Update every node in a Texinfo file. Ftexinfo-sequential-node-update Update one node (or many) in a Texinfo file with sequential pointers. This function causes the `Next' or `Previous' pointer to point to the immediately preceding or following node, even if it is at a higher or lower hierarchical level in the document. Continually pressing `n' or `p' takes you straight through the file. Without any prefix argument, update the node in which point is located. Non-nil argument (prefix, if interactive) means update the nodes in the marked region. This command makes it awkward to navigate among sections and subsections; it should be used only for those documents that are meant to be read like a novel rather than a reference, and for which the Info `g*' command is inadequate. Ftime-stamp Update the time stamp string in the buffer. Only does its thing if the variable time-stamp-active is non-nil. Typically used on write-file-hooks for automatic time-stamping. The format of the time stamp is determined by the variable time-stamp-format. The first time-stamp-line-limit lines of the buffer (normally 8) are searched for the time stamp template, and if it is found, a new time stamp is written into it. Vdisplay-time-day-and-date *Non-nil means \[display-time] should display day and date as well as time. Fdisplay-time Display current time, load level, and mail flag in mode line of each buffer. Updates automatically every minute. If `display-time-day-and-date' is non-nil, the current day and date are displayed as well. After each update, `display-time-hook' is run with `run-hooks'. If `display-time-echo-area' is non-nil, the time is displayed in the echo area instead of in the mode-line. Funderline-region Underline all nonblank characters in the region. Works by overstriking underscores. Called from program, takes two arguments START and END which specify the range to operate on. Fununderline-region Remove all underlining (overstruck underscores) in the region. Called from program, takes two arguments START and END which specify the range to operate on. Funoverstrike-region Remove all overstriking (character-backspace-character) in the region. Called from program, takes two arguments START and END which specify the range to operate on. Foverstrike-region Overstrike (character-backspace-character) all nonblank characters in the region. Called from program, takes two arguments START and END which specify the range to operate on. Fununderline-and-unoverstrike-region Remove underlining and overstriking in the region. Called from a program, takes two arguments START and END which specify the range to operate on. Vcopyright-do-not-disturb *If non-nil, the existing copyright holder is checked against this regexp. If it does not match, then a new copyright line is added with the copyright holder set to the value of `copyright-whoami'. Vcopyright-whoami *A string containing the name of the owner of new copyright notices. Vcopyright-notice-file *If non-nil, replace copying notices with this file. Fupdate-copyright Update the copyright notice at the beginning of the buffer to indicate the current year. If optional arg REPLACE is given (interactively, with prefix arg) replace the years in the notice rather than adding the current year after them. If `copyright-notice-file' is set, the copying permissions following the copyright are replaced as well. If optional third argument ASK is non-nil, the user is prompted for whether or not to update the copyright. If optional fourth argument ASK-YEAR is non-nil, the user is prompted for whether or not to replace the year rather than adding to it. Fask-to-update-copyright If the current buffer contains a copyright notice that is out of date, ask the user if it should be updated with `update-copyright' (which see). Put this on write-file-hooks. Vvc-checkin-hook *List of functions called after a checkin is done. See `run-hooks'. Fvc-file-status Display the current status of the file being visited. Currently, this is only defined for CVS. The information provided in the modeline is generally sufficient for RCS and SCCS. Fvc-next-action Do the next logical checkin or checkout operation on the current file. For RCS and SCCS files: If the file is not already registered, this registers it for version control and then retrieves a writable, locked copy for editing. If the file is registered and not locked by anyone, this checks out a writable and locked file ready for editing. If the file is checked out and locked by the calling user, this first checks to see if the file has changed since checkout. If not, it performs a revert. If the file has been changed, this pops up a buffer for entry of a log message; when the message has been entered, it checks in the resulting changes along with the log message as change commentary. If the variable `vc-keep-workfiles' is non-nil (which is its default), a read-only copy of the changed file is left in place afterwards. If the file is registered and locked by someone else, you are given the option to steal the lock. For CVS files: If the file is not already registered, this registers it for version control. This does a "cvs add", but no "cvs commit". If the file is added but not committed, it is committed. If the file has not been changed, neither in your working area or in the repository, a message is printed and nothing is done. If your working file is changed, but the repository file is unchanged, this pops up a buffer for entry of a log message; when the message has been entered, it checks in the resulting changes along with the logmessage as change commentary. A writable file is retained. If the repository file is changed, you are asked if you want to merge in the changes into your working copy. The following is true regardless of which version control system you are using: If you call this from within a VC dired buffer with no files marked, it will operate on the file in the current line. If you call this from within a VC dired buffer, and one or more files are marked, it will accept a log message and then operate on each one. The log message will be used as a comment for any register or checkin operations, but ignored when doing checkouts. Attempted lock steals will raise an error. For checkin, a prefix argument lets you specify the version number to use. Fvc-register Register the current file into your version-control system. Fvc-diff Display diffs between file versions. Normally this compares the current file and buffer with the most recent checked in version of that file. This uses no arguments. With a prefix argument, it reads the file name to use and two version designators specifying which versions to compare. Fvc-version-diff For FILE, report diffs between two stored versions REL1 and REL2 of it. If FILE is a directory, generate diffs between versions for all registered files in or below it. Fvc-version-other-window Visit version REV of the current buffer in another window. If the current buffer is named `F', the version is named `F.~REV~'. If `F.~REV~' already exists, it is used instead of being re-created. Fvc-insert-headers Insert headers in a file for use with your version-control system. Headers desired are inserted at the start of the buffer, and are pulled from the variable `vc-header-alist'. Fvc-directory Show version-control status of all files in the directory DIR. If the second argument VERBOSE is non-nil, show all files; otherwise show only files that current locked in the version control system. Interactively, supply a prefix arg to make VERBOSE non-nil. If the optional third argument NESTED is non-nil, scan the entire tree of subdirectories of the current directory. Fvc-create-snapshot Make a snapshot called NAME. The snapshot is made from all registered files at or below the current directory. For each file, the version level of its latest version becomes part of the named configuration. Fvc-retrieve-snapshot Retrieve the snapshot called NAME. This function fails if any files are locked at or below the current directory Otherwise, all registered files are checked out (unlocked) at their version levels in the snapshot. Fvc-print-log List the change log of the current buffer in a window. Fvc-revert-buffer Revert the current buffer's file back to the latest checked-in version. This asks for confirmation if the buffer contents are not identical to that version. If the back-end is CVS, this will give you the most recent revision of the file on the branch you are editing. Fvc-cancel-version Get rid of most recently checked in version of this file. A prefix argument means do not revert the buffer afterwards. Fvc-rename-file Rename file OLD to NEW, and rename its master file likewise. Fvc-update-change-log Find change log file and add entries from recent RCS logs. The mark is left at the end of the text prepended to the change log. With prefix arg of C-u, only find log entries for the current buffer's file. With any numeric prefix arg, find log entries for all files currently visited. Otherwise, find log entries for all registered files in the default directory. From a program, any arguments are passed to the `rcs2log' script. Fwebster Look up a word in the Webster's dictionary. Open a network login connection to a webster host if necessary. Communication with host is recorded in a buffer *webster*. Fwebster-endings Look up endings for a word in the Webster's dictionary. Open a network login connection to a webster host if necessary. Communication with host is recorded in a buffer *webster*. Fwebster-spell Look spelling for a word in the Webster's dictionary. Open a network login connection to a webster host if necessary. Communication with host is recorded in a buffer *webster*. Vscheme-program-name *Program invoked by the `run-scheme' command. Vscheme-band-name *Band loaded by the `run-scheme' command. Vscheme-program-arguments *Arguments passed to the Scheme program by the `run-scheme' command. Frun-scheme Run an inferior Scheme process. Output goes to the buffer `*scheme*'. With argument, asks for a command line. Fcvs-update Run a 'cvs update' in the current working directory. Feed the output to a *cvs* buffer and run cvs-mode on it. If optional prefix argument LOCAL is non-nil, 'cvs update -l' is run. Fcvs-update-other-window Run a 'cvs update' in the current working directory. Feed the output to a *cvs* buffer, display it in the other window, and run cvs-mode on it. If optional prefix argument LOCAL is non-nil, 'cvs update -l' is run. Fdescribe-buffer-case-table Describe the case table of the current buffer. Fdebug Enter debugger. To return, type \<debugger-mode-map>`\[debugger-continue]'. Arguments are mainly for use when this is called from the internals of the evaluator. You may call with no args, or you may pass nil as the first arg and any other args you like. In that case, the list of args after the first will be printed into the backtrace buffer. Fdebug-on-entry Request FUNCTION to invoke debugger each time it is called. If you tell the debugger to continue, FUNCTION's execution proceeds. This works by modifying the definition of FUNCTION, which must be written in Lisp, not predefined. Use \[cancel-debug-on-entry] to cancel the effect of this command. Redefining FUNCTION also cancels it. Fcancel-debug-on-entry Undo effect of \[debug-on-entry] on FUNCTION. If argument is nil or an empty string, cancel for all functions. Fdescribe-current-display-table Describe the display table in use in the selected window and buffer. Fmake-display-table Return a new, empty display table. Fstandard-display-8bit Display characters in the range L to H literally. Fstandard-display-default Display characters in the range L to H using the default notation. Fstandard-display-ascii Display character C using printable string S. Fstandard-display-g1 Display character C as character SC in the g1 character set. This function assumes that your terminal uses the SO/SI characters; it is meaningless for an X frame. Fstandard-display-graphic Display character C as character GC in graphics character set. This function assumes VT100-compatible escapes; it is meaningless for an X frame. Fstandard-display-underline Display character C as character UC plus underlining. Fstandard-display-european Toggle display of European characters encoded with ISO 8859. When enabled, characters in the range of 160 to 255 display not as octal escapes, but as accented characters. With prefix argument, enable European character display iff arg is positive. Fsetenv Set the value of the environment variable named VARIABLE to VALUE. VARIABLE should be a string. VALUE is optional; if not provided or is `nil', the environment variable VARIABLE will be removed. This function works by modifying `process-environment'. Fname-last-kbd-macro Assign a name to the last keyboard macro defined. Argument SYMBOL is the name to define. The symbol's function definition becomes the keyboard macro string. Such a "function" cannot be called from Lisp, but it is a valid editor command. Finsert-kbd-macro Insert in buffer the definition of kbd macro NAME, as Lisp code. Optional second argument KEYS means also record the keys it is on (this is the prefix argument, when calling interactively). This Lisp code will, when executed, define the kbd macro with the same definition it has now. If you say to record the keys, the Lisp code will also rebind those keys to the macro. Only global key bindings are recorded since executing this Lisp code always makes global bindings. To save a kbd macro, visit a file of Lisp code such as your `~/.emacs', use this command, and then save the file. Fkbd-macro-query Query user during kbd macro execution. With prefix argument, enters recursive edit, reading keyboard commands even within a kbd macro. You can give different commands each time the macro executes. Without prefix argument, asks whether to continue running the macro. Your options are: \<query-replace-map> \[act] Finish this iteration normally and continue with the next. \[skip] Skip the rest of this iteration, and start the next. \[exit] Stop the macro entirely right now. \[recenter] Redisplay the frame, then ask again. \[edit] Enter recursive edit; ask again when you exit from that. Fapply-macro-to-region-lines For each complete line between point and mark, move to the beginning of the line, and run the last keyboard macro. When called from lisp, this function takes two arguments TOP and BOTTOM, describing the current region. TOP must be before BOTTOM. The optional third argument MACRO specifies a keyboard macro to execute. This is useful for quoting or unquoting included text, adding and removing comments, or producing tables where the entries are regular. For example, in Usenet articles, sections of text quoted from another author are indented, or have each line start with `>'. To quote a section of text, define a keyboard macro which inserts `>', put point and mark at opposite ends of the quoted section, and use `\[apply-macro-to-region-lines]' to mark the entire section. Suppose you wanted to build a keyword table in C where each entry looked like this: { "foo", foo_data, foo_function }, { "bar", bar_data, bar_function }, { "baz", baz_data, baz_function }, You could enter the names in this format: foo bar baz and write a macro to massage a word into a table entry: \C-x ( \M-d { "\C-y", \C-y_data, \C-y_function }, \C-x ) and then select the region of un-tablified names and use `\[apply-macro-to-region-lines]' to build the table from the names. Fenable-command Allow COMMAND to be executed without special confirmation from now on. The user's .emacs file is altered so that this will apply to future sessions. Fdisable-command Require special confirmation to execute COMMAND from now on. The user's .emacs file is altered so that this will apply to future sessions. Flist-options Display a list of XEmacs user options, with values and documentation. Fedit-options Edit a list of XEmacs user option values. Selects a buffer containing such a list, in which there are commands to set the option values. Type \[describe-mode] in that buffer for a list of commands. Fdelete-rectangle Delete (don't save) text in rectangle with point and mark as corners. The same range of columns is deleted in each line starting with the line where the region begins and ending with the line where the region ends. Fdelete-extract-rectangle Delete contents of rectangle and return it as a list of strings. Arguments START and END are the corners of the rectangle. The value is list of strings, one for each line of the rectangle. Fextract-rectangle Return contents of rectangle with corners at START and END. Value is list of strings, one for each line of the rectangle. Vkilled-rectangle Rectangle for yank-rectangle to insert. Fkill-rectangle Delete rectangle with corners at point and mark; save as last killed one. Calling from program, supply two args START and END, buffer positions. But in programs you might prefer to use `delete-extract-rectangle'. Fyank-rectangle Yank the last killed rectangle with upper left corner at point. Finsert-rectangle Insert text of RECTANGLE with upper left corner at point. RECTANGLE's first line is inserted at point, its second line is inserted at a point vertically under point, etc. RECTANGLE should be a list of strings. After this command, the mark is at the upper left corner and point is at the lower right corner. Fopen-rectangle Blank out rectangle with corners at point and mark, shifting text right. The text previously in the region is not overwritten by the blanks, but instead winds up to the right of the rectangle. Fstring-rectangle Insert STRING on each line of the region-rectangle, shifting text right. The left edge of the rectangle specifies the column for insertion. This command does not delete or overwrite any existing text. Called from a program, takes three args; START, END and STRING. Fclear-rectangle Blank out rectangle with corners at point and mark. The text previously in the region is overwritten by the blanks. When called from a program, requires two args which specify the corners. Freposition-window Make the current definition and/or comment visible. Further invocations move it to the top of the window or toggle the visibility of comments that precede it. Point is left unchanged unless prefix ARG is supplied. If the definition is fully onscreen, it is moved to the top of the window. If it is partly offscreen, the window is scrolled to get the definition (or as much as will fit) onscreen, unless point is in a comment which is also partly offscreen, in which case the scrolling attempts to get as much of the comment onscreen as possible. Initially `reposition-window' attempts to make both the definition and preceding comments visible. Further invocations toggle the visibility of the comment lines. If ARG is non-nil, point may move in order to make the whole defun visible (if only part could otherwise be made so), to make the defun line visible (if point is in code and it could not be made so, or if only comments, including the first comment line, are visible), or to make the first comment line visible (if point is in a comment). Fsort-subr General text sorting routine to divide buffer into records and sort them. Arguments are REVERSE NEXTRECFUN ENDRECFUN &optional STARTKEYFUN ENDKEYFUN. We divide the accessible portion of the buffer into disjoint pieces called sort records. A portion of each sort record (perhaps all of it) is designated as the sort key. The records are rearranged in the buffer in order by their sort keys. The records may or may not be contiguous. Usually the records are rearranged in order of ascending sort key. If REVERSE is non-nil, they are rearranged in order of descending sort key. The next four arguments are functions to be called to move point across a sort record. They will be called many times from within sort-subr. NEXTRECFUN is called with point at the end of the previous record. It moves point to the start of the next record. It should move point to the end of the buffer if there are no more records. The first record is assumed to start at the position of point when sort-subr is called. ENDRECFUN is called with point within the record. It should move point to the end of the record. STARTKEYFUN moves from the start of the record to the start of the key. It may return either a non-nil value to be used as the key, or else the key is the substring between the values of point after STARTKEYFUN and ENDKEYFUN are called. If STARTKEYFUN is nil, the key starts at the beginning of the record. ENDKEYFUN moves from the start of the sort key to the end of the sort key. ENDKEYFUN may be nil if STARTKEYFUN returns a value or if it would be the same as ENDRECFUN. Fsort-lines Sort lines in region alphabetically; argument means descending order. Called from a program, there are three arguments: REVERSE (non-nil means reverse order), BEG and END (region to sort). Fsort-paragraphs Sort paragraphs in region alphabetically; argument means descending order. Called from a program, there are three arguments: REVERSE (non-nil means reverse order), BEG and END (region to sort). Fsort-pages Sort pages in region alphabetically; argument means descending order. Called from a program, there are three arguments: REVERSE (non-nil means reverse order), BEG and END (region to sort). Fsort-numeric-fields Sort lines in region numerically by the ARGth field of each line. Fields are separated by whitespace and numbered from 1 up. Specified field must contain a number in each line of the region. With a negative arg, sorts by the ARGth field counted from the right. Called from a program, there are three arguments: FIELD, BEG and END. BEG and END specify region to sort. If you want to sort floating-point numbers, try `sort-float-fields'. Fsort-float-fields Sort lines in region numerically by the ARGth field of each line. Fields are separated by whitespace and numbered from 1 up. Specified field must contain a floating point number in each line of the region. With a negative arg, sorts by the ARGth field counted from the right. Called from a program, there are three arguments: FIELD, BEG and END. BEG and END specify region to sort. Fsort-fields Sort lines in region lexicographically by the ARGth field of each line. Fields are separated by whitespace and numbered from 1 up. With a negative arg, sorts by the ARGth field counted from the right. Called from a program, there are three arguments: FIELD, BEG and END. BEG and END specify region to sort. Fsort-regexp-fields Sort the region lexicographically as specified by RECORD-REGEXP and KEY. RECORD-REGEXP specifies the textual units which should be sorted. For example, to sort lines RECORD-REGEXP would be "^.*$" KEY specifies the part of each record (ie each match for RECORD-REGEXP) is to be used for sorting. If it is "\digit" then the digit'th "$...$" match field from RECORD-REGEXP is used. If it is "\&" then the whole record is used. Otherwise, it is a regular-expression for which to search within the record. If a match for KEY is not found within a record then that record is ignored. With a negative prefix arg sorts in reverse order. For example: to sort lines in the region by the first word on each line starting with the letter "f", RECORD-REGEXP would be "^.*$" and KEY would be "\=\<f\w*\>" Fsort-columns Sort lines in region alphabetically by a certain range of columns. For the purpose of this command, the region includes the entire line that point is in and the entire line the mark is in. The column positions of point and mark bound the range of columns to sort on. A prefix argument means sort into reverse order. Note that `sort-columns' rejects text that contains tabs, because tabs could be split across the specified columns and it doesn't know how to handle that. Also, when possible, it uses the `sort' utility program, which doesn't understand tabs. Use \[untabify] to convert tabs to spaces before sorting. Freverse-region Reverse the order of lines in a region. From a program takes two point or marker arguments, BEG and END. Fload-sound-file Read in an audio-file and add it to the sound-alist. You can only play sound files if you are running on display 0 of the console of a Sun SparcStation, SGI machine, or HP9000s700, or running a NetAudio server. The sound file must be in the Sun/NeXT U-LAW format. Fload-default-sounds Load and install some sound files as beep-types. This only works if you're on display 0 of a Sun SparcStation, SGI machine, or HP9000s700, or running a NetAudio server. Funtabify Convert all tabs in region to multiple spaces, preserving columns. Called non-interactively, the region is specified by arguments START and END, rather than by the position of point and mark. The variable `tab-width' controls the spacing of tab stops. Ftabify Convert multiple spaces in region to tabs when possible. A group of spaces is partially replaced by tabs when this can be done without changing the column they end at. Called non-interactively, the region is specified by arguments START and END, rather than by the position of point and mark. The variable `tab-width' controls the spacing of tab stops. Fask-user-about-lock Ask user what to do when he wants to edit FILE but it is locked by USER. This function has a choice of three things to do: do (signal 'buffer-file-locked (list FILE USER)) to refrain from editing the file return t (grab the lock on the file) return nil (edit the file even though it is locked). You can rewrite it to use any criterion you like to choose which one to do. Fask-user-about-supersession-threat Ask a user who is about to modify an obsolete buffer what to do. This function has two choices: it can return, in which case the modification of the buffer will proceed, or it can (signal 'file-supersession (file)), in which case the proposed buffer modification will not be made. You can rewrite this to use any criterion you like to choose which one to do. The buffer in question is current when this function is called. Vrmail-dont-reply-to-names *A regexp specifying names to prune of reply to messages. A value of nil means exclude your own name only. Vrmail-default-dont-reply-to-names A regular expression specifying part of the value of the default value of the variable `rmail-dont-reply-to-names', for when the user does not set `rmail-dont-reply-to-names' explicitly. (The other part of the default value is the user's name.) It is useful to set this variable in the site customization file. Vrmail-delete-after-output *Non-nil means automatically delete a message that is copied to a file. Vrmail-primary-inbox-list *List of files which are inboxes for user's primary mail file `~/RMAIL'. `nil' means the default, which is ("/usr/spool/mail/$USER") (the name varies depending on the operating system, and the value of the environment variable MAIL overrides it). Vrmail-mail-new-frame *Non-nil means Rmail makes a new frame for composing outgoing mail. Vrmail-retry-setup-hook Hook that `rmail-retry-failure' uses in place of `mail-setup-hook'. Frmail Read and edit incoming mail. Moves messages into file named by `rmail-file-name' (a babyl format file) and edits that file in RMAIL Mode. Type \[describe-mode] once editing that file, for a list of RMAIL commands. May be called with filename as argument; then performs rmail editing on that file, but does not copy any new mail into the file. Frmail-mode Rmail Mode is used by \<rmail-mode-map>\[rmail] for editing Rmail files. All normal editing commands are turned off. Instead, these commands are available: \[rmail-beginning-of-message] Move point to front of this message (same as \[beginning-of-buffer]). \[scroll-up] Scroll to next screen of this message. \[scroll-down] Scroll to previous screen of this message. \[rmail-next-undeleted-message] Move to Next non-deleted message. \[rmail-previous-undeleted-message] Move to Previous non-deleted message. \[rmail-next-message] Move to Next message whether deleted or not. \[rmail-previous-message] Move to Previous message whether deleted or not. \[rmail-first-message] Move to the first message in Rmail file. \[rmail-last-message] Move to the last message in Rmail file. \[rmail-show-message] Jump to message specified by numeric position in file. \[rmail-search] Search for string and show message it is found in. \[rmail-delete-forward] Delete this message, move to next nondeleted. \[rmail-delete-backward] Delete this message, move to previous nondeleted. \[rmail-undelete-previous-message] Undelete message. Tries current message, then earlier messages till a deleted message is found. \[rmail-edit-current-message] Edit the current message. \[rmail-cease-edit] to return to Rmail. \[rmail-expunge] Expunge deleted messages. \[rmail-expunge-and-save] Expunge and save the file. \[rmail-quit] Quit Rmail: expunge, save, then switch to another buffer. \[save-buffer] Save without expunging. \[rmail-get-new-mail] Move new mail from system spool directory into this file. \[rmail-mail] Mail a message (same as \[mail-other-window]). \[rmail-continue] Continue composing outgoing message started before. \[rmail-reply] Reply to this message. Like \[rmail-mail] but initializes some fields. \[rmail-retry-failure] Send this message again. Used on a mailer failure message. \[rmail-forward] Forward this message to another user. \[rmail-output-to-rmail-file] Output this message to an Rmail file (append it). \[rmail-output] Output this message to a Unix-format mail file (append it). \[rmail-input] Input Rmail file. Run Rmail on that file. \[rmail-add-label] Add label to message. It will be displayed in the mode line. \[rmail-kill-label] Kill label. Remove a label from current message. \[rmail-next-labeled-message] Move to Next message with specified label (label defaults to last one specified). Standard labels: filed, unseen, answered, forwarded, deleted. Any other label is present only if you add it with \[rmail-add-label]. \[rmail-previous-labeled-message] Move to Previous message with specified label \[rmail-summary] Show headers buffer, with a one line summary of each message. \[rmail-summary-by-labels] Summarize only messages with particular label(s). \[rmail-summary-by-recipients] Summarize only messages with particular recipient(s). \[rmail-summary-by-regexp] Summarize only messages with particular regexp(s). \[rmail-summary-by-topic] Summarize only messages with subject line regexp(s). \[rmail-toggle-header] Toggle display of complete header. Frmail-input Run Rmail on file FILENAME. Fbatch-unrmail Convert Rmail files to mailbox files. Specify the input Rmail file names as command line arguments. For each Rmail file, the corresponding output file name is made by adding `.mail' at the end. For example, invoke `emacs -batch -f batch-unrmail RMAIL'. Funrmail Convert Rmail file FILE to mailbox-format file TO-FILE. Vad-redefinition-action *Defines what to do with redefinitions during Advice de/activation. Redefinition occurs if a previously activated function that already has an original definition associated with it gets redefined and then de/activated. In such a case we can either accept the current definition as the new original definition, discard the current definition and replace it with the old original, or keep it and raise an error. The values `accept', `discard', `error' or `warn' govern what will be done. `warn' is just like `accept' but it additionally prints a warning message. All other values will be interpreted as `error'. Vad-default-compilation-action *Defines whether to compile advised definitions during activation. A value of `always' will result in unconditional compilation, `never' will always avoid compilation, `maybe' will compile if the byte-compiler is already loaded, and `like-original' will compile if the original definition of the advised function is compiled or a built-in function. Every other value will be interpreted as `maybe'. This variable will only be considered if the COMPILE argument of `ad-activate' was supplied as nil. Fad-add-advice Adds a piece of ADVICE to FUNCTION's list of advices in CLASS. If FUNCTION already has one or more pieces of advice of the specified CLASS then POSITION determines where the new piece will go. The value of POSITION can either be `first', `last' or a number where 0 corresponds to `first'. Numbers outside the range will be mapped to the closest extreme position. If there was already a piece of ADVICE with the same name, then the position argument will be ignored and the old advice will be overwritten with the new one. If the FUNCTION was not advised already, then its advice info will be initialized. Redefining a piece of advice whose name is part of the cache-id will clear the cache. Fdefadvice Defines a piece of advice for FUNCTION (a symbol). The syntax of `defadvice' is as follows: (defadvice FUNCTION (CLASS NAME [POSITION] [ARGLIST] FLAG...) [DOCSTRING] [INTERACTIVE-FORM] BODY... ) FUNCTION ::= Name of the function to be advised. CLASS ::= `before' | `around' | `after' | `activation' | `deactivation'. NAME ::= Non-nil symbol that names this piece of advice. POSITION ::= `first' | `last' | NUMBER. Optional, defaults to `first', see also `ad-add-advice'. ARGLIST ::= An optional argument list to be used for the advised function instead of the argument list of the original. The first one found in before/around/after-advices will be used. FLAG ::= `protect'|`disable'|`activate'|`compile'|`preactivate'|`freeze'. All flags can be specified with unambiguous initial substrings. DOCSTRING ::= Optional documentation for this piece of advice. INTERACTIVE-FORM ::= Optional interactive form to be used for the advised function. The first one found in before/around/after-advices will be used. BODY ::= Any s-expression. Semantics of the various flags: `protect': The piece of advice will be protected against non-local exits in any code that precedes it. If any around-advice of a function is protected then automatically all around-advices will be protected (the complete onion). `activate': All advice of FUNCTION will be activated immediately if FUNCTION has been properly defined prior to this application of `defadvice'. `compile': In conjunction with `activate' specifies that the resulting advised function should be compiled. `disable': The defined advice will be disabled, hence, it will not be used during activation until somebody enables it. `preactivate': Preactivates the advised FUNCTION at macro-expansion/compile time. This generates a compiled advised definition according to the current advice state that will be used during activation if appropriate. Only use this if the `defadvice' gets actually compiled. `freeze': Expands the `defadvice' into a redefining `defun/defmacro' according to this particular single advice. No other advice information will be saved. Frozen advices cannot be undone, they behave like a hard redefinition of the advised function. `freeze' implies `activate' and `preactivate'. The documentation of the advised function can be dumped onto the `DOC' file during preloading. Look at the file `advice.el' for comprehensive documentation. Fupdate-file-autoloads Update the autoloads for FILE in `generated-autoload-file' (which FILE might bind in its local variables). Fupdate-autoloads-here Update sections of the current buffer generated by \[update-file-autoloads]. Fupdate-directory-autoloads Run \[update-file-autoloads] on each .el file in DIR. Fbatch-update-autoloads Update the autoloads for the files or directories on the command line. Runs \[update-file-autoloads] on files and \[update-directory-autoloads] on directories. Must be used only with -batch, and kills Emacs on completion. Each file will be processed even if an error occurred previously. For example, invoke `emacs -batch -f batch-update-autoloads *.el'. Fdefine-derived-mode Create a new mode as a variant of an existing mode. The arguments to this command are as follow: PARENT: the name of the command for the parent mode (ie. text-mode). CHILD: the name of the command for the derived mode. NAME: a string which will appear in the status line (ie. "Hypertext") DOCSTRING: an optional documentation string--if you do not supply one, the function will attempt to invent something useful. BODY: forms to execute just before running the hooks for the new mode. Here is how you could define LaTeX-Thesis mode as a variant of LaTeX mode: (define-derived-mode LaTeX-thesis-mode LaTeX-mode "LaTeX-Thesis") You could then make new key bindings for `LaTeX-thesis-mode-map' without changing regular LaTeX mode. In this example, BODY is empty, and DOCSTRING is generated by default. On a more complicated level, the following command uses sgml-mode as the parent, and then sets the variable `case-fold-search' to nil: (define-derived-mode article-mode sgml-mode "Article" "Major mode for editing technical articles." (setq case-fold-search nil)) Note that if the documentation string had been left out, it would have been generated automatically, with a reference to the keymap. Fderived-mode-init-mode-variables Initialise variables for a new mode. Right now, if they don't already exist, set up a blank keymap, an empty syntax table, and an empty abbrev table -- these will be merged the first time the mode is used. Fdocref-setup Process docref cross-references in the current buffer. See also \(f@docref-subst). Feasy-menu-define Define a menu bar submenu in maps MAPS, according to MENU. The arguments SYMBOL and DOC are ignored; they are present for compatibility only. SYMBOL is not evaluated. In other Emacs versions these arguments may be used as a variable to hold the menu data, and a doc string for that variable. The first element of MENU must be a string. It is the menu bar item name. The rest of the elements are menu items. A menu item is usually a vector of three elements: [NAME CALLBACK ENABLE] NAME is a string--the menu item name. CALLBACK is a command to run when the item is chosen, or a list to evaluate when the item is chosen. ENABLE is an expression; the item is enabled for selection whenever this expression's value is non-nil. Alternatively, a menu item may have the form: [ NAME CALLBACK [ KEYWORD ARG ] ... ] Where KEYWORD is one of the symbol defined below. :keys KEYS KEYS is a string; a complex keyboard equivalent to this menu item. :active ENABLE ENABLE is an expression; the item is enabled for selection whenever this expression's value is non-nil. :suffix NAME NAME is a string; the name of an argument to CALLBACK. :style STYLE STYLE is a symbol describing the type of menu item. The following are defined: toggle: A checkbox. Currently just prepend the name with the string "Toggle ". radio: A radio button. nil: An ordinary menu item. :selected SELECTED SELECTED is an expression; the checkbox or radio button is selected whenever this expression's value is non-nil. Currently just disable radio buttons, no effect on checkboxes. A menu item can be a string. Then that string appears in the menu as unselectable text. A string consisting solely of hyphens is displayed as a solid horizontal line. A menu item can be a list. It is treated as a submenu. The first element should be the submenu name. That's used as the menu item in the top-level menu. The cdr of the submenu list is a list of menu items, as above. Felp-instrument-function Instrument FUNSYM for profiling. FUNSYM must be a symbol of a defined function. Felp-restore-function Restore an instrumented function to its original definition. Argument FUNSYM is the symbol of a defined function. Felp-instrument-list Instrument for profiling, all functions in `elp-function-list'. Use optional LIST if provided instead. Felp-instrument-package Instrument for profiling, all functions which start with PREFIX. For example, to instrument all ELP functions, do the following: \[elp-instrument-package] RET elp- RET Felp-results Display current profiling results. If `elp-reset-after-results' is non-nil, then current profiling information for all instrumented functions are reset after results are displayed. Felp-submit-bug-report Submit via mail, a bug report on elp. Fenable-flow-control Toggle flow control handling. When handling is enabled, user can type C-s as C-\, and C-q as C-^. With arg, enable flow control mode if arg is positive, otherwise disable. Fenable-flow-control-on Enable flow control if using one of a specified set of terminal types. Use `(enable-flow-control-on "vt100" "h19")' to enable flow control on VT-100 and H19 terminals. When flow control is enabled, you must type C-\ to get the effect of a C-s, and type C-^ to get the effect of a C-q. Fforms-mode Major mode to visit files in a field-structured manner using a form. Commands: Equivalent keys in read-only mode: TAB forms-next-field TAB C-c TAB forms-next-field C-c < forms-first-record < C-c > forms-last-record > C-c ? describe-mode ? C-c C-k forms-delete-record C-c C-q forms-toggle-read-only q C-c C-o forms-insert-record C-c C-l forms-jump-record l C-c C-n forms-next-record n C-c C-p forms-prev-record p C-c C-s forms-search s C-c C-x forms-exit x Fforms-find-file Visit a file in Forms mode. Fforms-find-file-other-window Visit a file in Forms mode in other window. Fhighlight-headers Highlight message headers between start and end. Faces used: message-headers the part before the colon message-header-contents the part after the colon message-highlighted-header-contents contents of "special" headers message-cited-text quoted text from other messages Variables used: highlight-headers-regexp what makes a "special" header highlight-headers-citation-regexp matches lines of quoted text highlight-headers-citation-header-regexp matches headers for quoted text If HACK-SIG is true,then we search backward from END for something that looks like the beginning of a signature block, and don't consider that a part of the message (this is because signatures are often incorrectly interpreted as cited text.) Funload-feature Unload the library that provided FEATURE, restoring all its autoloads. If the feature is required by any other loaded code, and optional FORCE is nil, raise an error. Fmail-extract-address-components Given an RFC-822 ADDRESS, extract full name and canonical address. Returns a list of the form (FULL-NAME CANONICAL-ADDRESS). If no name can be extracted, FULL-NAME will be nil. ADDRESS may be a string or a buffer. If it is a buffer, the visible (narrowed) portion of the buffer will be interpreted as the address. (This feature exists so that the clever caller might be able to avoid consing a string.) If ADDRESS contains more than one RFC-822 address, only the first is returned. Some day this function may be extended to extract multiple addresses, or perhaps return the position at which parsing stopped. Fwhat-domain Prompts for a mail domain, and prints the country it corresponds to in the minibuffer. Vmail-use-rfc822 *If non-nil, use a full, hairy RFC822 parser on mail addresses. Otherwise, (the default) use a smaller, somewhat faster and often-correct parser. Fmap-y-or-n-p Ask a series of boolean questions. Takes args PROMPTER ACTOR LIST, and optional arg HELP. LIST is a list of objects, or a function of no arguments to return the next object or nil. If PROMPTER is a string, the prompt is (format PROMPTER OBJECT). If not a string, PROMPTER is a function of one arg (an object from LIST), which returns a string to be used as the prompt for that object. If the return value is not a string, it is eval'd to get the answer; it may be nil to ignore the object, t to act on the object without asking the user, or a form to do a more complex prompt. ACTOR is a function of one arg (an object from LIST), which gets called with each object that the user answers `yes' for. If HELP is given, it is a list (OBJECT OBJECTS ACTION), where OBJECT is a string giving the singular noun for an elt of LIST; OBJECTS is the plural noun for elts of LIST, and ACTION is a transitive verb describing ACTOR. The default is ("object" "objects" "act on"). At the prompts, the user may enter y, Y, or SPC to act on that object; n, N, or DEL to skip that object; ! to act on all following objects; ESC or q to exit (skip all following objects); . (period) to act on the current object and then exit; or \[help-command] to get help. Returns the number of actions taken. Fread-passwd Prompts for a password in the minibuffer, and returns it as a string. If PROMPT may be a prompt string or an alist of elements '(prompt . default). If optional arg CONFIRM is true, then ask the user to type the password again to confirm that they typed it correctly. If optional arg DEFAULT is provided, then it is a string to insert as the default choice (it is not, of course, displayed.) If running under X, the keyboard will be grabbed (with XGrabKeyboard()) to reduce the possibility that evesdropping is occuring. When reading a password, all keys self-insert, except for: \<read-passwd-map> \[read-passwd-erase-line] Erase the entire line. \[quoted-insert] Insert the next character literally. \[delete-backward-char] Delete the previous character. \[exit-minibuffer] Accept what you have typed. \[keyboard-quit] Abort the command. The returned value is always a newly-created string. No additional copies of the password remain after this function has returned. NOTE: unless great care is taken, the typed password will exist in plaintext form in the running image for an arbitrarily long time. Priveleged users may be able to extract it from memory. If emacs crashes, it may appear in the resultant core file. Some steps you can take to prevent the password from being copied around: - as soon as you are done with the returned string, destroy it with (fillarray string 0). The same goes for any default passwords or password histories. - do not copy the string, as with concat or substring - if you do, be sure to keep track of and destroy all copies. - do not insert the password into a buffer - if you do, be sure to overwrite the buffer text before killing it, as with the functions `passwd-erase-buffer' or `passwd-kill-buffer'. Note that deleting the text from the buffer does NOT necessarily remove the text from memory. - be careful of the undo history - if you insert the password into a buffer which has undo recording turned on, the password will be copied onto the undo list, and thus recoverable. - do not pass it as an argument to a shell command - anyone will be able to see it if they run `ps' at the right time. Note that the password will be temporarily recoverable with the `view-lossage' command. This data will not be overwritten until another hundred or so characters are typed. There's not currently a way around this. Fpp Output the pretty-printed representation of OBJECT, any Lisp object. Quoting characters are printed when needed to make output that `read' can handle, whenever this is possible. Output stream is STREAM, or value of `standard-output' (which see). Fring-p Returns t if X is a ring; nil otherwise. Fmake-ring Make a ring that can contain SIZE elements. Fget-text-property Returns the value of the PROP property at the given position. Fextent-properties-at Returns the properties of the character at the given position, by merging the properties of overlapping extents. The returned value is a property list, some of which may be shared with other structures. You must not modify it. This returns all properties on all extents. Ftext-properties-at Returns the properties of the character at the given position, by merging the properties of overlapping extents. The returned value is a property list, some of which may be shared with other structures. You must not modify it. This returns only those properties added with `put-text-property'. See also `extent-properties-at'. Ftext-property-any Check text from START to END to see if PROP is ever `eq' to VALUE. If so, return the position of the first character whose PROP is `eq' to VALUE. Otherwise return nil. The optional fifth argument, OBJECT, is the buffer containing the text. Ftext-property-not-all Check text from START to END to see if PROP is ever not `eq' to VALUE. If so, return the position of the first character whose PROP is not `eq' to VALUE. Otherwise, return nil. The optional fifth argument, OBJECT, is the buffer containing the text. Fnext-property-change Return the position of next property change. Scans forward from POS in BUFFER (defaults to the current buffer) until it finds a change in some text property, then returns the position of the change. Returns nil if the properties remain unchanged all the way to the end. If the value is non-nil, it is a position greater than POS, never equal. If the optional third argument LIMIT is non-nil, don't search past position LIMIT; return LIMIT if nothing is found before LIMIT. If two or more extents with conflicting non-nil values for a property overlap a particular character, it is undefined which value is considered to be the value of the property. (Note that this situation will not happen if you always use the text-property primitives.) Fprevious-property-change Return the position of previous property change. Scans backward from POS in BUFFER (defaults to the current buffer) until it finds a change in some text property, then returns the position of the change. Returns nil if the properties remain unchanged all the way to the beginning. If the value is non-nil, it is a position less than POS, never equal. If the optional third argument LIMIT is non-nil, don't search back past position LIMIT; return LIMIT if nothing is found until LIMIT. If two or more extents with conflicting non-nil values for a property overlap a particular character, it is undefined which value is considered to be the value of the property. (Note that this situation will not happen if you always use the text-property primitives.) Ftq-create Create and return a transaction queue communicating with PROCESS. PROCESS should be a subprocess capable of sending and receiving streams of bytes. It may be a local process, or it may be connected to a tcp server on another machine. Vtrace-buffer *Trace output will by default go to that buffer. Ftrace-function Traces FUNCTION with trace output going to BUFFER. For every call of FUNCTION Lisp-style trace messages that display argument and return values will be inserted into BUFFER. This function generates the trace advice for FUNCTION and activates it together with any other advice there might be!! The trace BUFFER will popup whenever FUNCTION is called. Do not use this to trace functions that switch buffers or do any other display oriented stuff, use `trace-function-background' instead. Ftrace-function-background Traces FUNCTION with trace output going quietly to BUFFER. For every call of FUNCTION Lisp-style trace messages that display argument and return values will be inserted into BUFFER. This function generates the trace advice for FUNCTION and activates it together with any other advice there might be!! Trace output will quietly go to BUFFER without changing the window or buffer configuration at all. Fwith-timeout Usage: (with-timeout (seconds &rest timeout-forms) &rest body) This is just like progn, but if the given number of seconds expires before the body returns, then timeout-forms are evaluated and returned instead. The body won't be interrupted in the middle of a computation: the check for the timer expiration only occurs when body does a redisplay, or prompts the user for input, or calls accept-process-output. Fyes-or-no-p-with-timeout Just like yes-or-no-p, but will time out after TIMEOUT seconds if the user has not yes answered, returning DEFAULT-VALUE. Fy-or-n-p-with-timeout Just like y-or-n-p, but will time out after TIMEOUT seconds if the user has not yes answered, returning DEFAULT-VALUE. Fviper-mode Turn on Viper emulation of Vi. Fvm-easy-menu-define Define a menu bar submenu in maps MAPS, according to MENU. The menu keymap is stored in symbol SYMBOL, both as its value and as its function definition. DOC is used as the doc string for SYMBOL. The first element of MENU must be a string. It is the menu bar item name. The rest of the elements are menu items. A menu item is usually a vector of three elements: [NAME CALLBACK ENABLE] NAME is a string--the menu item name. CALLBACK is a command to run when the item is chosen, or a list to evaluate when the item is chosen. ENABLE is an expression; the item is enabled for selection whenever this expression's value is non-nil. Alternatively, a menu item may have the form: [ NAME CALLBACK [ KEYWORD ARG ] ... ] Where KEYWORD is one of the symbol defined below. :keys KEYS KEYS is a string; a complex keyboard equivalent to this menu item. This is normally not needed because keyboard equivalents are usually computed automatically. :active ENABLE ENABLE is an expression; the item is enabled for selection whenever this expression's value is non-nil. :suffix NAME NAME is a string; the name of an argument to CALLBACK. :style STYLE is a symbol describing the type of menu item. The following are defined: toggle: A checkbox. Currently just prepend the name with the string "Toggle ". radio: A radio button. nil: An ordinary menu item. :selected SELECTED SELECTED is an expression; the checkbox or radio button is selected whenever this expression's value is non-nil. Currently just disable radio buttons, no effect on checkboxes. A menu item can be a string. Then that string appears in the menu as unselectable text. A string consisting solely of hyphens is displayed as a solid horizontal line. A menu item can be a list. It is treated as a submenu. The first element should be the submenu name. That's used as the menu item in the top-level menu. The cdr of the submenu list is a list of menu items, as above. Furl-file-attributes Return a list of attributes of URL. Value is nil if specified file cannot be opened. Otherwise, list elements are: 0. t for directory, string (name linked to) for symbolic link, or nil. 1. Number of links to file. 2. File uid. 3. File gid. 4. Last access time, as a list of two integers. First integer has high-order 16 bits of time, second has low 16 bits. 5. Last modification time, likewise. 6. Last status change time, likewise. 7. Size in bytes. (-1, if number is out of range). 8. File modes, as a string of ten letters or dashes as in ls -l. If URL is on an http server, this will return the content-type if possible. 9. t iff file's gid would change if file were deleted and recreated. 10. inode number. 11. Device number. If file does not exist, returns nil. Furl-normalize-url Return a 'normalized' version of URL. This strips out default port numbers, etc. Furl-buffer-visiting Return the name of a buffer (if any) that is visiting URL. Furl-get-url-at-point Get the URL closest to point, but don't change your position. Has a preference for looking backward when not directly on a symbol. Furl-popup-info Retrieve the HTTP/1.0 headers and display them in a temp buffer. Furl-cache-expired Return t iff a cached file has expired. Furl-retrieve Retrieve a document over the World Wide Web. The document should be specified by its fully specified Uniform Resource Locator. No parsing is done, just return the document as the server sent it. The document is left in the buffer specified by url-working-buffer. url-working-buffer is killed immediately before starting the transfer, so that no buffer-local variables interfere with the retrieval. HTTP/1.0 redirection will be honored before this function exits. Fw3-use-hotlist Possibly go to a link in your W3/Mosaic hotlist. This is part of the emacs World Wide Web browser. It will prompt for one of the items in your 'hotlist'. A hotlist is a list of often visited or interesting items you have found on the World Wide Web. Fw3-open-local Find a local file, and interpret it as a hypertext document. It will prompt for an existing file or directory, and retrieve it as a hypertext document. If it is a directory, and url-use-hypertext-dired is non-nil, then an HTML directory listing is created on the fly. Otherwise, dired-mode is used to visit the buffer. Fw3-fetch-other-frame Attempt to follow the hypertext reference under point in a new frame. With prefix-arg P, ignore viewers and dump the link straight to disk. Fw3-fetch Retrieve a document over the World Wide Web. The World Wide Web is a global hypertext system started by CERN in Switzerland in 1991. The document should be specified by its fully specified Uniform Resource Locator. The document will be parsed, printed, or passed to an external viewer as appropriate. Variable `mm-mime-info' specifies viewers for particular file types. Fw3-maybe-follow-link-mouse Maybe follow a hypertext link under point. If there is no link under point, this will try using url-get-url-at-point Fw3-maybe-follow-link Maybe follow a hypertext link under point. If there is no link under point, this will try using url-get-url-at-point Fw3-follow-url-at-point-other-frame Follow the URL under PT, defaults to link under (point) Fw3-follow-url-at-point Follow the URL under PT, defaults to link under (point) Fw3-batch-fetch Fetch all the URLs on the command line and save them to files in the current directory. The first argument after the -f w3-batch-fetch on the command line should be a string specifying how to save the information retrieved. If it is "html", then the page will be unformatted when it is written to disk. If it is "text", then the page will be formatted before it is written to disk. If it is "binary" it will not mess with the file extensions, and just save the data in raw binary format. If none of those, the default is "text", and the first argument is treated as a normal URL. Fw3-preview-this-buffer See what this buffer will look like when its formatted as HTML. HTML is the HyperText Markup Language used by the World Wide Web to specify formatting for text. More information on HTML can be found at ftp.w3.org:/pub/www/doc. Fw3 Retrieve the default World Wide Web home page. The World Wide Web is a global hypertext system started by CERN in Switzerland in 1991. The home page is specified by the variable w3-default-homepage. The document should be specified by its fully specified Uniform Resource Locator. The document will be parsed as HTML (if appropriate) and displayed in a new buffer. Fw3-follow-link-other-frame Attempt to follow the hypertext reference under point in a new frame. With prefix-arg P, ignore viewers and dump the link straight to disk. Fw3-follow-link Attempt to follow the hypertext reference under point. With prefix-arg P, ignore viewers and dump the link straight to disk. Vfont-menu-ignore-scaled-fonts *If non-nil, then the font menu will try to show only bitmap fonts. Vfont-menu-this-frame-only-p *If non-nil, then changing the default font from the font menu will only affect one frame instead of all frames. Freset-device-font-menus Generates the `Font', `Size', and `Weight' submenus for the Options menu. This is run the first time that a font-menu is needed for each device. If you don't like the lazy invocation of this function, you can add it to `create-device-hook' and that will make the font menus respond more quickly when they are selected for the first time. If you add fonts to your system, or if you change your font path, you can call this to re-initialize the menus. Fproclaim-inline Cause the named functions to be open-coded when called from compiled code. They will only be compiled open-coded when byte-optimize is true. Fproclaim-notinline Cause the named functions to no longer be open-coded. Fdefsubst Define an inline function. The syntax is just like that of `defun'. Fmake-obsolete Make the byte-compiler warn that FUNCTION is obsolete. The warning will say that NEW should be used instead. If NEW is a string, that is the `use instead' message. Fmake-obsolete-variable Make the byte-compiler warn that VARIABLE is obsolete, and NEW should be used instead. If NEW is a string, then that is the `use instead' message. Fdont-compile Like `progn', but the body always runs interpreted (not compiled). If you think you need this, you're probably making a mistake somewhere. Feval-when-compile Like `progn', but evaluates the body at compile time. The result of the body appears to the compiler as a quoted constant. Feval-and-compile Like `progn', but evaluates the body at compile time and at load time. Fbyte-compiler-options Set some compilation-parameters for this file. This will affect only the file in which it appears; this does nothing when evaluated, and when loaded from a .el file. Each argument to this macro must be a list of a key and a value. Keys: Values: Corresponding variable: verbose t, nil byte-compile-verbose optimize t, nil, source, byte byte-optimize warnings list of warnings byte-compile-warnings file-format emacs18, emacs19 byte-compile-emacs18-compatibility new-bytecodes t, nil byte-compile-generate-emacs19-bytecodes The value specificed with the `warnings' option must be a list, containing some subset of the following flags: free-vars references to variables not in the current lexical scope. unused-vars references to non-global variables bound but not referenced. unresolved calls to unknown functions. callargs lambda calls with args that don't match the definition. redefine function cell redefined from a macro to a lambda or vice versa, or redefined to take a different number of arguments. If the first element if the list is `+' or `-' then the specified elements are added to or removed from the current set of warnings, instead of the entire set of warnings being overwritten. For example, something like this might appear at the top of a source file: (byte-compiler-options (optimize t) (warnings (- callargs)) ; Don't warn about arglist mismatch (warnings (+ unused-vars)) ; Do warn about unused bindings (file-format emacs19)) Vpi The value of Pi (3.1415926...) Ve The value of e (2.7182818...) Vdegrees-to-radians Degrees to radian conversion constant Vradians-to-degrees Radian to degree conversion constant Fdegrees-to-radians Convert ARG from degrees to radians. Fradians-to-degrees Convert ARG from radians to degrees. Vitimer-version Version number of the itimer package. Vitimer-list List of all active itimers. Vitimer-edit-map Keymap used when in Itimer Edit mode. Fcheck-itimer If VAR is not bound to an itimer, signal wrong-type-argument. This is a macro. Fcheck-itimer-coerce-string If VAR is not bound to a string, look up the itimer that it names and bind VAR to it. Otherwise if VAR is not bound to an itimer, signal wrong-type-argument. This is a macro. Fitimer-check-natnum If VAR is not bound to a non-negative number, signal wrong-type-argument. This is a macro. Fitimer-check-string If VAR is not bound to a string, signal wrong-type-argument. This is a macro. Fitimerp Returns non-nil iff OBJ is an itimer. Fitimer-name Returns the name of ITIMER. Fitimer-value Returns the number of seconds until ITIMER expires. Fitimer-restart Returns the value to which ITIMER will be set at restart. nil is returned if this itimer doesn't restart. Fitimer-function Returns the function of ITIMER. This function is called each time ITIMER expires. Fitimer-id Returns the timeout-id of ITIMER. Fset-itimer-value Set the timeout value of ITIMER to be VALUE. Itimer will expire is this many seconds. Returns VALUE. Fset-itimer-restart Set the restart value of ITIMER to be RESTART. If RESTART is nil, ITIMER will not restart when it expires. Returns RESTART. Fset-itimer-function Set the function of ITIMER to be FUNCTION. FUNCTION will be called when itimer expires. Returns FUNCTION. Fget-itimer Return itimer named NAME, or nil if there is none. Fread-itimer Read the name of an itimer from the minibuffer and return the itimer associated with that name. The user is prompted with PROMPT. Optional second arg INITIAL-INPUT non-nil is inserted into the minibuffer as initial user input. Fdelete-itimer Deletes ITIMER. ITIMER may be an itimer or the name of one. Fstart-itimer Start an itimer. Args are NAME, FUNCTION, VALUE &optional RESTART. NAME is an identifier for the itimer. It must be a string. If an itimer already exists with this name, NAME will be modified slightly to until it is unique. FUNCTION should be a function (or symbol naming one) of no arguments. It will be called each time the itimer expires. The function can access itimer that invoked it through the variable `current-itimer'. VALUE is the number of seconds until this itimer expires. Optional fourth arg RESTART non-nil means that this itimer should be restarted automatically after its function is called. Normally an itimer is deleted at expiration after its function has returned. If non-nil RESTART should be a number indicating the value at which the itimer should be set at restart time. Returns the newly created itimer. Flist-itimers Pop up a buffer containing a list of all itimers. The major mode of the buffer is Itimer Edit mode. This major mode provides commands to manipulate itimers; see the documentation for `itimer-edit-mode' for more information. Fedit-itimers Display a list of all itimers and select it for editing. The major mode of the buffer containing the listing is Itimer Edit mode. This major mode provides commands to manipulate itimers; see the documentation for `itimer-edit-mode' for more information. Fitimer-edit-mode Major mode for manipulating itimers. Atrributes of running itimers are changed by moving the cursor to the desired field and typing `s' to set that field. The field will then be set to the value read from the minibuffer. Commands: TAB move forward a field DEL move backward a field s set a field d delete the selected itimer x start a new itimer ? help Fitimer-edit-help Help function for Itimer Edit. Fitimer-edit-quit End Itimer Edit. Vauto-save-timeout *Number of seconds idle time before auto-save. Zero or nil means disable auto-saving due to idleness. The actual amount of idle time between auto-saves is logarithmically related to the size of the current buffer. This variable is the number of seconds after which an auto-save will happen when the current buffer is 50k or less; the timeout will be 2 1/4 times this in a 200k buffer, 3 3/4 times this in a 1000k buffer, and 4 1/2 times this in a 2000k buffer. See also the variable `auto-save-interval', which controls auto-saving based on the number of characters typed. Vauto-gc-threshold *GC when this many bytes have been consed since the last GC, and the user has been idle for `auto-save-timeout' seconds. Fauto-save-itimer For use as a itimer callback function. Auto-saves and garbage-collects based on the size of the current buffer and the value of `auto-save-timeout', `auto-gc-threshold', and the current keyboard idle-time. Fscrollbar-char-left Function called when the char-left arrow on the scrollbar is clicked. This is the little arrow to the left of the scrollbar. One argument is passed, the scrollbar's window. You can advise this function to change the scrollbar behavior. Fscrollbar-char-right Function called when the char-right arrow on the scrollbar is clicked. This is the little arrow to the right of the scrollbar. One argument is passed, the scrollbar's window. You can advise this function to change the scrollbar behavior. Fscrollbar-page-left Function called when the user gives the "page-left" scrollbar action. (The way this is done can vary from scrollbar to scrollbar.) One argument is passed, the scrollbar's window. You can advise this function to change the scrollbar behavior. Fscrollbar-page-right Function called when the user gives the "page-right" scrollbar action. (The way this is done can vary from scrollbar to scrollbar.) One argument is passed, the scrollbar's window. You can advise this function to change the scrollbar behavior. Fscrollbar-to-left Function called when the user gives the "to-left" scrollbar action. (The way this is done can vary from scrollbar to scrollbar.). One argument is passed, the scrollbar's window. You can advise this function to change the scrollbar behavior. Fscrollbar-to-right Function called when the user gives the "to-right" scrollbar action. (The way this is done can vary from scrollbar to scrollbar.). One argument is passed, the scrollbar's window. You can advise this function to change the scrollbar behavior. Fscrollbar-horizontal-drag Function called when the user drags the horizontal scrollbar thumb. One argument is passed, a cons containing the scrollbar's window and a value representing how many columns the thumb is slid over. You can advise this function to change the scrollbar behavior. Vonly-global-abbrevs *t means user plans to use global abbrevs only. Makes the commands to define mode-specific abbrevs define global ones instead. Vabbrev-table-name-list List of symbols whose values are abbrev tables. Vabbrevs-changed Set non-nil by defining or altering any word abbrevs. This causes `save-some-buffers' to offer to save the abbrevs. Fmake-abbrev-table Create a new, empty abbrev table object. Fclear-abbrev-table Undefine all abbrevs in abbrev table TABLE, leaving it empty. Fdefine-abbrev-table Define TABNAME (a symbol) as an abbrev table name. Define abbrevs in it according to DEFINITIONS, which is a list of elements of the form (ABBREVNAME EXPANSION HOOK USECOUNT). Fdefine-abbrev Define an abbrev in TABLE named NAME, to expand to EXPANSION or call HOOK. NAME and EXPANSION are strings. Hook is a function or `nil'. To undefine an abbrev, define with the an expansion of `nil'. Fdefine-global-abbrev Define ABBREV as a global abbreviation for EXPANSION. Fdefine-mode-abbrev Define ABBREV as a mode-specific abbreviation for EXPANSION. Fabbrev-symbol Return the symbol representing abbrev named ABBREV. This symbol's name is ABBREV, but it is not the canonical symbol of that name; it is interned in an abbrev-table rather than the normal obarray. The value is nil if that abbrev is not defined. Optional second arg TABLE is abbrev table to look it up in. The default is to try buffer's mode-specific abbrev table, then global table. Fabbrev-expansion Return the string that ABBREV expands into in the current buffer. Optionally specify an abbrev table as second arg; then ABBREV is looked up in that table only. Funexpand-abbrev Undo the expansion of the last abbrev that expanded. This differs from ordinary undo in that other editing done since then is not undone. Finsert-abbrev-table-description Insert before point a full description of abbrev table named NAME. NAME is a symbol whose value is an abbrev table. If optional 2nd arg HUMAN is non-nil, insert a human-readable description. Otherwise the description is an expression, a call to `define-abbrev-table', which would define the abbrev table NAME exactly as it is currently defined. Fabbrev-mode Toggle abbrev mode. With arg, turn abbrev mode on iff arg is positive. In abbrev mode, inserting an abbreviation causes it to expand and be replaced by its expansion. Vedit-abbrevs-map Keymap used in edit-abbrevs. Fkill-all-abbrevs Undefine all defined abbrevs. Finsert-abbrevs Insert after point a description of all defined abbrevs. Mark is set after the inserted text. Flist-abbrevs Display a list of all defined abbrevs. Fedit-abbrevs-mode Major mode for editing the list of abbrev definitions. \{edit-abbrevs-map} Fedit-abbrevs Alter abbrev definitions by editing a list of them. Selects a buffer containing a list of abbrev definitions. You can edit them and type C-c C-c to redefine abbrevs according to your editing. Buffer contains a header line for each abbrev table, which is the abbrev table name in parentheses. This is followed by one line per abbrev in that table: NAME USECOUNT EXPANSION HOOK where NAME and EXPANSION are strings with quotes, USECOUNT is an integer, and HOOK is any valid function or may be omitted (it is usually omitted). Fedit-abbrevs-redefine Redefine abbrevs according to current buffer contents. Fdefine-abbrevs Define abbrevs according to current visible buffer contents. See documentation of edit-abbrevs for info on the format of the text you must have in the buffer. With argument, eliminate all abbrev definitions except the ones defined from the buffer now. Fread-abbrev-file Read abbrev definitions from file written with write-abbrev-file. Takes file name as argument. Optional second argument non-nil means don't print anything. Fquietly-read-abbrev-file Read abbrev definitions from file written with write-abbrev-file. Takes file name as argument. Does not print anything. Fwrite-abbrev-file Write all abbrev definitions to file of Lisp code. The file can be loaded to define the same abbrevs. Fadd-mode-abbrev Define mode-specific abbrev for last word(s) before point. Argument is how many words before point form the expansion; or zero means the region is the expansion. A negative argument means to undefine the specified abbrev. Reads the abbreviation in the minibuffer. Don't use this function in a Lisp program; use define-abbrev instead. Fadd-global-abbrev Define global (all modes) abbrev for last word(s) before point. Argument is how many words before point form the expansion; or zero means the region is the expansion. A negative argument means to undefine the specified abbrev. Reads the abbreviation in the minibuffer. Don't use this function in a Lisp program; use define-abbrev instead. Finverse-add-mode-abbrev Define last word before point as a mode-specific abbrev. With argument N, defines the Nth word before point. Reads the expansion in the minibuffer. Expands the abbreviation after defining it. Finverse-add-global-abbrev Define last word before point as a global (mode-independent) abbrev. With argument N, defines the Nth word before point. Reads the expansion in the minibuffer. Expands the abbreviation after defining it. Fabbrev-prefix-mark Mark current point as the beginning of an abbrev. Abbrev to be expanded starts here rather than at beginning of word. This way, you can expand an abbrev with a prefix: insert the prefix, use this command, then insert the abbrev. Fexpand-region-abbrevs For abbrev occurrence in the region, offer to expand it. The user is asked to type y or n for each occurrence. A numeric argument means don't query; expand all abbrevs. Calling from a program, arguments are START END &optional NOQUERY. Ffile-menu-filter Incrementally update the file menu. This function changes the arguments and sensitivity of these File menu items: Delete Buffer has the name of the current buffer appended to it. Print Buffer has the name of the current buffer appended to it. Pretty-Print Buffer has the name of the current buffer appended to it. Save has the name of the current buffer appended to it, and is sensitive only when the current buffer is modified. Revert Buffer has the name of the current buffer appended to it, and is sensitive only when the current buffer has a file. Delete Frame sensitive only when there is more than one frame. The name of the current buffer is only appended to the menu items if `put-buffer-names-in-file-menu' is non-nil. This behavior is the default. Fedit-menu-filter For use as an incremental menu construction filter. This function changes the sensitivity of these Edit menu items: Cut sensitive only when emacs owns the primary X Selection. Copy sensitive only when emacs owns the primary X Selection. Clear sensitive only when emacs owns the primary X Selection. Paste sensitive only when there is an owner for the X Clipboard Selection. Undo sensitive only when there is undo information. While in the midst of an undo, this is changed to "Undo More". Fslow-format-buffers-menu-line Returns a string to represent the given buffer in the Buffer menu. nil means the buffer shouldn't be listed. You can redefine this. Fformat-buffers-menu-line Returns a string to represent the given buffer in the Buffer menu. nil means the buffer shouldn't be listed. You can redefine this. Vbuffers-menu-max-size *Maximum number of entries which may appear on the "Buffers" menu. If this is 10, then only the ten most-recently-selected buffers will be shown. If this is nil, then all buffers will be shown. Setting this to a large number or nil will slow down menu responsiveness. Vcomplex-buffers-menu-p *If true, the buffers menu will contain several commands, as submenus of each buffer line. If this is false, then there will be only one command: select that buffer. Vbuffers-menu-switch-to-buffer-function *The function to call to select a buffer from the buffers menu. `switch-to-buffer' is a good choice, as is `pop-to-buffer'. Fbuffers-menu-filter This is the menu filter for the top-level buffers "Buffers" menu. It dynamically creates a list of buffers to use as the contents of the menu. Only the most-recently-used few buffers will be listed on the menu, for efficiency reasons. You can control how many buffers will be shown by setting `buffers-menu-max-size'. You can control the text of the menu items by redefining the function `format-buffers-menu-line'. Voptions-menu-saved-forms The variables to save; or forms to evaluate to get forms to write out. Vsave-options-file File to save options into. Fsave-options-menu-settings Saves the current settings of the `Options' menu to your `.emacs' file. Vglobal-popup-menu The global popup menu. This is present in all modes. See the function `popup-menu' for a description of menu syntax. Vmode-popup-menu The mode-specific popup menu. Automatically buffer local. This is appended to the default items in `global-popup-menu'. See the function `popup-menu' for a description of menu syntax. Vactivate-popup-menu-hook Function or functions run before a mode-specific popup menu is made visible. These functions are called with no arguments, and should interrogate and modify the value of `global-popup-menu' or `mode-popup-menu' as desired. Note: this hook is only run if you use `popup-mode-menu' for activating the global and mode-specific commands; if you have your own binding for button3, this hook won't be run. Fpopup-mode-menu Pop up a menu of global and mode-specific commands. The menu is computed by combining `global-popup-menu' and `mode-popup-menu'. Fpopup-buffer-menu Pop up a copy of the Buffers menu (from the menubar) where the mouse is clicked. Fpopup-menubar-menu Pop up a copy of menu that also appears in the menubar Fkill-this-buffer Kill the current buffer. Fset-menubar Set the default menubar to be MENUBAR. See `current-menubar' for a description of the syntax of a menubar. Fset-buffer-menubar Set the buffer-local menubar to be MENUBAR. See `current-menubar' for a description of the syntax of a menubar. Ffind-menu-item Search MENUBAR for item given by ITEM-PATH-LIST starting from PARENT. Returns (ITEM . PARENT), where PARENT is the immediate parent of the item found. If the item does not exist, the car of the returned value is nil. If some menu in the ITEM-PATH-LIST does not exist, an error is signalled. Freplace-list-element Destructively replace OLD element with NEW element in LIST. Returns the new list. Fadd-menu-button Add a menu item to some menu, creating the menu first if necessary. If the named item exists already, it is changed. MENU-PATH identifies the menu under which the new menu item should be inserted. It is a list of strings; for example, ("File") names the top-level "File" menu. ("File" "Foo") names a hypothetical submenu of "File". MENU-LEAF is a menubar leaf node. See the documentation of `current-menubar'. BEFORE, if provided, is the name of a menu item before which this item should be added, if this item is not on the menu already. If the item is already present, it will not be moved. Fadd-submenu Add a menu to the menubar or one of its submenus. If the named menu exists already, it is changed. MENU-PATH identifies the menu under which the new menu should be inserted. It is a list of strings; for example, ("File") names the top-level "File" menu. ("File" "Foo") names a hypothetical submenu of "File". If MENU-PATH is nil, then the menu will be added to the menubar itself. SUBMENU is the new menu to add. See the documentation of `current-menubar' for the syntax. BEFORE, if provided, is the name of a menu before which this menu should be added, if this menu is not on its parent already. If the menu is already present, it will not be moved. Fdelete-menu-item Remove the named menu item from the menu hierarchy. PATH is a list of strings which identify the position of the menu item in the menu hierarchy. The documentation of `add-submenu' describes menu-paths. Frelabel-menu-item Change the string of the specified menu item. PATH is a list of strings which identify the position of the menu item in the menu hierarchy. ("File" "Save") means the menu item called "Save" under the toplevel "File" menu. ("Menu" "Foo" "Item") means the menu item called "Item" under the "Foo" submenu of "Menu". NEW-NAME is the string that the menu item will be printed as from now on. Fenable-menu-item Make the named menu item be selectable. PATH is a list of strings which identify the position of the menu item in the menu hierarchy. ("File" "Save") means the menu item called "Save" under the toplevel "File" menu. ("Menu" "Foo" "Item") means the menu item called "Item" under the "Foo" submenu of "Menu". Fdisable-menu-item Make the named menu item be unselectable. PATH is a list of strings which identify the position of the menu item in the menu hierarchy. ("File" "Save") means the menu item called "Save" under the toplevel "File" menu. ("Menu" "Foo" "Item") means the menu item called "Item" under the "Foo" submenu of "Menu". Fselect-toggle-menu-item Make the named toggle- or radio-style menu item be in the `selected' state. PATH is a list of strings which identify the position of the menu item in the menu hierarchy. ("File" "Save") means the menu item called "Save" under the toplevel "File" menu. ("Menu" "Foo" "Item") means the menu item called "Item" under the "Foo" submenu of "Menu". Fdeselect-toggle-menu-item Make the named toggle- or radio-style menu item be in the `unselected' state. PATH is a list of strings which identify the position of the menu item in the menu hierarchy. ("File" "Save") means the menu item called "Save" under the toplevel "File" menu. ("Menu" "Foo" "Item") means the menu item called "Item" under the "Foo" submenu of "Menu". Fyes-or-no-p-dialog-box Ask user a "y or n" question with a popup dialog box. Returns t if answer is "yes". Takes one argument, which is the string to display to ask the question. Fyes-or-no-p-maybe-dialog-box Ask user a yes-or-no question. Return t if answer is yes. The question is asked with a dialog box or the minibuffer, as appropriate. Takes one argument, which is the string to display to ask the question. It should end in a space; `yes-or-no-p' adds `(yes or no) ' to it. The user must confirm the answer with RET, and can edit it until it as been confirmed. Fy-or-n-p-maybe-dialog-box Ask user a "y or n" question. Return t if answer is "y". Takes one argument, which is the string to display to ask the question. The question is asked with a dialog box or the minibuffer, as appropriate. It should end in a space; `y-or-n-p' adds `(y or n) ' to it. No confirmation of the answer is requested; a single character is enough. Also accepts Space to mean yes, or Delete to mean no. Fx-make-font-bold Given an X font specification, this attempts to make a `bold' font. If it fails, it returns nil. Fx-make-font-unbold Given an X font specification, this attempts to make a non-bold font. If it fails, it returns nil. Fx-make-font-italic Given an X font specification, this attempts to make an `italic' font. If it fails, it returns nil. Fx-make-font-unitalic Given an X font specification, this attempts to make a non-italic font. If it fails, it returns nil. Fx-make-font-bold-italic Given an X font specification, this attempts to make a `bold-italic' font. If it fails, it returns nil. Fx-font-size Return the nominal size of the given font. This is done by parsing its name, so it's likely to lose. X fonts can be specified (by the user) in either pixels or 10ths of points, and this returns the first one it finds, so you have to decide which units the returned value is measured in yourself... Fx-find-smaller-font Loads a new, slightly smaller version of the given font (or font name). Returns the font if it succeeds, nil otherwise. If scalable fonts are available, this returns a font which is 1 point smaller. Otherwise, it returns the next smaller version of this font that is defined. Fx-find-larger-font Loads a new, slightly larger version of the given font (or font name). Returns the font if it succeeds, nil otherwise. If scalable fonts are available, this returns a font which is 1 point larger. Otherwise, it returns the next larger version of this font that is defined. Fx-init-other-random-faces Initializes the colors and fonts of the bold, italic, bold-italic, zmacs-region, highlight, primary-selection, secondary-selection, and isearch faces when each device is created. If you want to add code to do stuff like this, use the create-device-hook. Viso8859/1-code-to-x-keysym-table Maps iso8859/1 to an X keysym name which corresponds to it. There may be more than one X name for this keycode; this returns the first one. Note that this is X specific; one should avoid using this table whenever possible, in the interest of portability. Vinhibit-help-echo Inhibits display of `help-echo' extent properties in the minibuffer. Fx-mouse-kill Kill the text between the point and mouse and copy it to the clipboard and to the cut buffer Fx-yank-function Insert the current X selection or, if there is none, insert the X cutbuffer. A mark is pushed, so that the inserted text lies between point and mark. Fx-insert-selection Insert the current selection into buffer at point. Fx-set-point-and-insert-selection Set point where clicked and insert the primary selection or the cut buffer. Fx-set-point-and-move-selection Set point where clicked and move the selected text to that location. Fmouse-track-and-copy-to-cutbuffer Make a selection like `mouse-track', but also copy it to the cutbuffer. Vx-pointer-shape *The shape of the mouse-pointer when over text. This string may be any of the standard cursor names from appendix B of the Xlib manual (also known as the file <X11/cursorfont.h>) minus the XC_ prefix, or it may be a font name and glyph index of the form "FONT fontname index [[font] index]", or it may be the name of a bitmap file acceptable to XmuLocateBitmapFile(). If it is a bitmap file, and if a bitmap file whose name is the name of the cursor with "msk" exists, then it is used as the mask. For example, a pair of files may be named "cursor.xbm" and "cursor.xbmmsk". Vx-nontext-pointer-shape *The shape of the mouse-pointer when over a buffer, but not over text. If this is nil, then `x-pointer-shape' is used. Vx-mode-pointer-shape *The shape of the mouse-pointer when over the modeline. If this is nil, then either `x-nontext-pointer-shape' or `x-pointer-shape' will be used. Vx-selection-pointer-shape *The shape of the mouse-pointer when over a selectable text region. Vx-busy-pointer-shape *The shape of the mouse-pointer when Emacs is busy. Vx-toolbar-pointer-shape *The shape of the mouse-pointer when over a toolbar. Vx-pointer-foreground-color *The foreground color of the mouse pointer. Vx-pointer-background-color *The background color of the mouse pointer. Fx-track-pointer For use as the value of `mouse-motion-handler'. This implements `x-pointer-shape' and related variables, as well as extent highlighting, and `mode-motion-hook'. Fx-init-pointer-shape Initializes the mouse-pointers of the given device from the resource database. Vmouse-track-rectangle-p *If true, then dragging out a region with the mouse selects rectangles instead of simple start/end regions. Vmouse-yank-at-point *If non-nil, the function `mouse-yank' will yank text at the cursor location. Otherwise, the cursor will be moved to the location of the pointer click before text is inserted. Vmouse-yank-function Function that is called upon by `mouse-yank' to actually insert text. Fmouse-select Select Emacs window the mouse is on. Fmouse-delete-window Delete the Emacs window the mouse is on. Fmouse-keep-one-window Select Emacs window mouse is on, then kill all other Emacs windows. Fmouse-select-and-split Select Emacs window mouse is on, then split it vertically in half. Fmouse-set-point Select Emacs window mouse is on, and move point to mouse position. Fmouse-yank Paste text with the mouse. If the variable `mouse-yank-at-point' is nil, then pasting occurs at the location of the click; otherwise, pasting occurs at the current cursor location. Fclick-inside-extent-p Returns non-nil if the button event is within the bounds of the primary selection-extent, nil otherwise. Fpoint-inside-extent-p Returns non-nil if the point is within or just after the bounds of the primary selection-extent, nil otherwise. Fmouse-eval-sexp Evaluate the sexp under the mouse. Usually, this is the last sexp before the click, but if you click on a left paren, then it is the sexp beginning with the paren that is evaluated. Also, since strings evaluate to themselves, they're fed to re-search-forward and the matched region is highlighted until the mouse button is released. Perhaps the most useful thing about this function is that the evaluation of the expression which is clicked upon is relative not to the window where you click, but to the current window and the current position of point. Thus, you can use `mouse-eval-sexp' to interactively test code that acts upon a buffer...something you cannot do with the standard `eval-last-sexp' function. It's also fantastic for debugging regular expressions. Fmouse-line-length Print the length of the line indicated by the pointer. Fmouse-set-mark Select Emacs window mouse is on, and set mark at mouse position. Display cursor at that position for a second. Fmouse-scroll Scroll point to the mouse position. Fmouse-del-char Delete the char pointed to by the mouse. Fmouse-kill-line Kill the line pointed to by the mouse. Fnarrow-window-to-region Narrow window to region between point and last mark Fmouse-window-to-region Narrow window to region between cursor and mouse pointer. Fmouse-ignore Don't do anything. Vmouse-track-down-hook Function or functions called when the user presses the mouse. This hook is invoked by `mouse-track'; thus, it will not be called for any buttons with a different binding. The functions will be called with two arguments: the button-press event and a click count (see `mouse-track-click-hook'). If any function returns non-nil, the remaining functions will not be called. Note that most applications should take action when the mouse is released, not when it is pressed.' Vmouse-track-drag-hook Function or functions called when the user drags the mouse. This hook is invoked by `mouse-track'; thus, it will not be called for any buttons with a different binding. The functions will be called with three arguments: the mouse-motion event, a click count (see `mouse-track-click-hook'), and whether the call to this hook occurred as a result of a drag timeout (see `mouse-track-scroll-delay'). If any function returns non-nil, the remaining functions will not be called. Note that no calls to this function will be made until the user initiates a drag (i.e. moves the mouse more than a certain threshold in either the X or the Y direction, as defined by `mouse-track-x-threshold' and `mouse-track-y-threshold'). See also `mouse-track-drag-up-hook'. Vmouse-track-drag-up-hook Function or functions called when the user finishes a drag. This hook is invoked by `mouse-track'; thus, it will not be called for any buttons with a different binding. The functions will be called with two arguments: the button-press event and a click count (see `mouse-track-click-hook'). If any function returns non-nil, the remaining functions will not be called. Note that this hook will not be invoked unless the user has initiated a drag, i.e. moved the mouse more than a certain threshold (see `mouse-track-drag-hook'). When this function is invoked, `mouse-track-drag-hook' will have been invoked at least once. See also `mouse-track-click-hook'. Vmouse-track-click-hook Function or functions called when the user clicks the mouse. `Clicking' means pressing and releasing the mouse without having initiated a drag (i.e. without having moved more than a certain threshold -- see `mouse-track-drag-hook'). This hook is invoked by `mouse-track'; thus, it will not be called for any buttons with a different binding. The functions will be called with two arguments: the button-release event and a click count, which specifies the number of times that the mouse has been clicked in a series of clicks, each of which is separated by at most `mouse-track-multi-click-time'. This can be used to implement actions that are called on double clicks, triple clicks, etc. If any function returns non-nil, the remaining functions will not be called. See also `mouse-track-drag-up-hook. Vmouse-track-up-hook Function or functions called when the user releases the mouse. This hook is invoked by `mouse-track'; thus, it will not be called for any buttons with a different binding. The functions will be called with two arguments: the button-release event and a click count (see `mouse-track-click-hook'). For many applications, it is more appropriate to use one or both of `mouse-track-click-hook' and `mouse-track-drag-up-hook'. Vmouse-track-cleanup-hook Function or functions called when `mouse-track' terminates. This hook will be called in all circumstances, even upon a non-local exit out of `mouse-track', and so is useful for doing cleanup work such as removing extents that may have been created during the operation of `mouse-track'. Unlike all of the other mouse-track hooks, this is a "normal" hook: the hook functions are called with no arguments, and all hook functions are called regardless of their return values. Vmouse-track-multi-click-time Maximum number of milliseconds allowed between clicks for a multi-click. See `mouse-track-click-hook'. Vmouse-track-scroll-delay Maximum of milliseconds between calls to `mouse-track-drag-hook'. If the user is dragging the mouse (i.e. the button is held down and a drag has been initiated) and does not move the mouse for this many milliseconds, the hook will be called with t as the value of the WAS-TIMEOUT parameter. This can be used to implement scrolling in a selection when the user drags the mouse out the window it was in. A value of nil disables the timeout feature. Vmouse-track-x-threshold Minimum number of pixels in the X direction for a drag to be initiated. If the mouse is moved more than either the X or Y threshold while the button is held down (see also `mouse-track-y-threshold'), then a drag is initiated; otherwise the gesture is considered to be a click. See `mouse-track'. The value should be either a number of a form to be evaluated to produce a number. Vmouse-track-y-threshold Minimum number of pixels in the Y direction for a drag to be initiated. If the mouse is moved more than either the X or Y threshold while the button is held down (see also `mouse-track-x-threshold'), then a drag is initiated; otherwise the gesture is considered to be a click. See `mouse-track'. The value should be either a number of a form to be evaluated to produce a number. Fmouse-track Make a selection with the mouse. This should be bound to a mouse button. The behavior of XEmacs during mouse selection is customizable using various hooks and variables: see `mouse-track-click-hook', `mouse-track-drag-hook', `mouse-track-drag-up-hook', `mouse-track-down-hook', `mouse-track-up-hook', `mouse-track-cleanup-hook', `mouse-track-multi-click-time', `mouse-track-scroll-delay', `mouse-track-x-threshold', and `mouse-track-y-threshold'. Default handlers are provided to implement standard selecting/positioning behavior. You can explicitly request this default behavior, and override any custom-supplied handlers, by using the function `mouse-track-default' instead of `mouse-track'. Default behavior is as follows: If you click-and-drag, the selection will be set to the region between the point of the initial click and the point at which you release the button. These positions need not be ordered. If you click-and-release without moving the mouse, then the point is moved and the selection is disowned (there will be no selection owner). The mark will be set to the previous position of point. If you double-click, the selection will extend by symbols instead of by characters. If you triple-click, the selection will extend by lines. If you drag the mouse off the top or bottom of the window, you can select pieces of text which are larger than the visible part of the buffer; the buffer will scroll as necessary. The selected text becomes the current X Selection, and is also copied to the top of the kill ring. The point will be left at the position at which you released the button, and the mark will be left at the initial click position. Fmouse-track-default Invoke `mouse-track' with only the default handlers active. Fmouse-track-do-rectangle Like `mouse-track' but selects rectangles instead of regions. Fmouse-track-adjust Extend the existing selection. This should be bound to a mouse button. The selection will be enlarged or shrunk so that the point of the mouse click is one of its endpoints. This function in fact behaves fairly similarly to `mouse-track', but begins by extending the existing selection (or creating a new selection from the previous text cursor position to the current mouse position) instead of creating a new, empty selection. The mouse-track handlers are run from this command just like from `mouse-track'. Therefore, do not call this command from a mouse-track handler! Fmouse-track-adjust-default Extend the existing selection, using only the default handlers. This is just like `mouse-track-adjust' but will override any custom mouse-track handlers that the user may have installed. Fmouse-track-insert Make a selection with the mouse and insert it at point. This is exactly the same as the `mouse-track' command on \[mouse-track], except that point is not moved; the selected text is immediately inserted after being selected; and the selection is immediately disowned afterwards. Fmouse-track-delete-and-insert Make a selection with the mouse and insert it at point. This is exactly the same as the `mouse-track' command on \[mouse-track], except that point is not moved; the selected text is immediately inserted after being selected; and the text of the selection is deleted. Vdrag-modeline-event-lag *The amount of time to wait (in msecs) between drag modeline events before updating the display. If this value is too small, dragging will be choppy because redisplay cannot keep up. If it is too large, dragging will be choppy because of the explicit redisplay delay specified. Vmodeline-click-swaps-buffers *If non-nil, clicking on the modeline changes the current buffer. Click on the left half of the modeline cycles forward through the buffer list and clicking on the right half cycles backward. Fmouse-drag-modeline Resize the window by dragging the modeline. This should be bound to a mouse button in `modeline-map'. Fmouse-release-modeline Handle modeline click EVENT on LINE-NUM by switching buffers. If click on left half of a frame's modeline, bury current buffer. If click on right half of a frame's modeline, raise bottommost buffer. Args are: EVENT, the mouse release event, and LINE-NUM, the line number within the frame at which the mouse was first depressed. Fpress-toolbar-button Press a toolbar button. This only changes its appearance. Frelease-and-activate-toolbar-button Release a toolbar button and activate its callback. Frelease-toolbar-button Release all pressed toolbar buttons. Vmode-motion-hook Function or functions which are called whenever the mouse moves. You should normally use this rather than `mouse-motion-handler', which does some additional window-system-dependent things. This hook is local to every buffer, and should normally be set up by major-modes which want to use special highlighting. Every time the mouse moves over a window, the mode-motion-hook of the buffer of that window is run. Vmode-motion-help-echo-string String to be added as the 'help-echo property of the mode-motion extent. In order for this to work, you need to add the hook function `mode-motion-add-help-echo' to the mode-motion hook. If this is a function, it will be called with one argument (the event) and should return a string to be added. This variable is local to every buffer. Fmode-motion-highlight-line For use as the value of `mode-motion-hook' -- highlight line under mouse. Fmode-motion-highlight-word For use as the value of `mode-motion-hook' -- highlight word under mouse. Fmode-motion-highlight-symbol For use as the value of `mode-motion-hook' -- highlight symbol under mouse. Fmode-motion-highlight-sexp For use as the value of `mode-motion-hook' -- highlight form under mouse. Fmode-motion-add-help-echo For use as the value of `mode-motion-hook' -- add a 'help-echo property. This causes the string in the 'help-echo property to be displayed when the mouse moves over the extent. See `mode-motion-help-echo-string' for documentation on how to control the string that is added. Fminibuf-select-highlighted-completion Select the highlighted text under the mouse as a minibuffer response. When the minibuffer is being used to prompt the user for a completion, any valid completions which are visible on the frame will highlight when the mouse moves over them. Clicking \<minibuffer-local-map>\[minibuf-select-highlighted-completion] will select the highlighted completion under the mouse. If the mouse is clicked while while not over a highlighted completion, then the global binding of \[minibuf-select-highlighted-completion] will be executed instead. In this way you can get at the normal global behavior of \[minibuf-select-highlighted-completion] as well as the special minibuffer behavior. Fminibuf-maybe-select-highlighted-completion Like minibuf-select-highlighted-completion but does nothing if there is no completion (as opposed to executing the global binding). Useful as the value of `mouse-track-click-hook'. Fx-get-selection Return text selected from some X window. Fx-get-secondary-selection Return text selected from some X window. Fx-get-clipboard Return text pasted to the clipboard. Vprimary-selection-extent The extent of the primary selection; don't use this. Vsecondary-selection-extent The extent of the secondary selection; don't use this. Fx-own-selection Make a primary X Selection of the given argument. The argument may be a string, a cons of two markers, or an extent. In the latter cases the selection is considered to be the text between the markers, or between the extent's endpoints. Fx-own-secondary-selection Make a secondary X Selection of the given argument. The argument may be a string or a cons of two markers (in which case the selection is considered to be the text between those markers). Fx-own-clipboard Paste the given string to the X Clipboard. Fx-disown-selection Assuming we own the selection, disown it. With an argument, discard the secondary selection instead of the primary selection. Fx-dehilight-selection for use as a value of `x-lost-selection-hooks'. Fx-notice-selection-requests for possible use as the value of x-sent-selection-hooks. Fx-notice-selection-failures for possible use as the value of x-sent-selection-hooks. Fx-get-cutbuffer Returns the value of one of the 8 X server cut buffers. Optional arg WHICH-ONE should be a number from 0 to 7, defaulting to 0. Cut buffers are considered obsolete; you should use selections instead. This function does nothing if support for cut buffers was not compiled into Emacs. Fx-store-cutbuffer Store the given string into the X server's primary cut buffer. The previous value of the primary cut buffer is rotated to the secondary cut buffer, and the second to the third, and so on (there are 8 buffers). Cut buffers are considered obsolete; you should use selections instead. This function does nothing if support for cut buffers was not compiled into Emacs. Fx-supports-cutbuffers-p Returns whether support for cut buffers was compiled into Emacs. Cut buffers are considered obsolete; you should use selections instead. Fx-copy-primary-selection Copy the selection to the Clipboard and the kill ring. Fx-kill-primary-selection Copy the selection to the Clipboard and the kill ring, then delete it. Fx-delete-primary-selection Delete the selection without copying it to the Clipboard or the kill ring. Fx-yank-clipboard-selection Insert the current Clipboard selection at point. Fx-bogosity-check-resource Check for a bogus resource specification. Fx-init-specifier-from-resources Initialize a specifier from the resource database. LOCALE specifies the locale that is to be initialized and should be a frame, a device, or 'global. TYPE is the type of the resource and should be one of 'string, 'boolean, 'integer, or 'natnum. The remaining args should be conses of names and classes of resources to be examined. The first resource with a value specified becomes the spec for SPECIFIER in LOCALE. (However, if SPECIFIER already has a spec in LOCALE, nothing is done.) Finally, if LOCALE is 'global, a check is done for bogus resource specifications.